@modelcontextprotocol/sdk
    Preparing search index...

    Type Alias SSEClientTransportOptions

    Configuration options for the SSEClientTransport.

    type SSEClientTransportOptions = {
        authProvider?: OAuthClientProvider;
        eventSourceInit?: EventSourceInit;
        fetch?: FetchLike;
        requestInit?: RequestInit;
    }
    Index

    Properties

    authProvider?: OAuthClientProvider

    An OAuth client provider to use for authentication.

    When an authProvider is specified and the SSE connection is started:

    1. The connection is attempted with any existing access token from the authProvider.
    2. If the access token has expired, the authProvider is used to refresh the token.
    3. If token refresh fails or no access token exists, and auth is required, OAuthClientProvider.redirectToAuthorization is called, and an UnauthorizedError will be thrown from connect/start.

    After the user has finished authorizing via their user agent, and is redirected back to the MCP client application, call SSEClientTransport.finishAuth with the authorization code before retrying the connection.

    If an authProvider is not provided, and auth is required, an UnauthorizedError will be thrown.

    UnauthorizedError might also be thrown when sending any message over the SSE transport, indicating that the session has expired, and needs to be re-authed and reconnected.

    eventSourceInit?: EventSourceInit

    Customizes the initial SSE request to the server (the request that begins the stream).

    NOTE: Setting this property will prevent an Authorization header from being automatically attached to the SSE request, if an authProvider is also given. This can be worked around by setting the Authorization header manually.

    fetch?: FetchLike

    Custom fetch implementation used for all network requests.

    requestInit?: RequestInit

    Customizes recurring POST requests to the server.