ailoy-web
    Preparing search index...

    Class MCPSSEClientTransport

    Client transport for SSE: this will connect to a server using Server-Sent Events for receiving messages and make separate POST requests for sending messages.

    Implements

    • Transport
    Index

    Constructors

    • Parameters

      • url: URL
      • Optionalopts: SSEClientTransportOptions

      Returns MCPSSEClientTransport

    Properties

    onclose?: () => void

    Callback for when the connection is closed for any reason.

    This should be invoked when close() is called as well.

    onerror?: (error: Error) => void

    Callback for when an error occurs.

    Note that errors are not necessarily fatal; they are used for reporting any kind of exceptional condition out of band.

    onmessage?: (message: JSONRPCMessage) => void

    Callback for when a message (request or response) is received over the connection.

    Includes the requestInfo and authInfo if the transport is authenticated.

    The requestInfo can be used to get the original request information (headers, etc.)

    Methods

    • Closes the connection.

      Returns Promise<void>

    • Call this method after the user has finished authorizing via their user agent and is redirected back to the MCP client application. This will exchange the authorization code for an access token, enabling the next connection attempt to successfully auth.

      Parameters

      • authorizationCode: string

      Returns Promise<void>

    • Sends a JSON-RPC message (request or response).

      If present, relatedRequestId is used to indicate to the transport which incoming request to associate this outgoing message with.

      Parameters

      • message: JSONRPCMessage

      Returns Promise<void>

    • Sets the protocol version used for the connection (called when the initialize response is received).

      Parameters

      • version: string

      Returns void

    • Starts processing messages on the transport, including any connection steps that might need to be taken.

      This method should only be called after callbacks are installed, or else messages may be lost.

      NOTE: This method should not be called explicitly when using Client, Server, or Protocol classes, as they will implicitly call start().

      Returns Promise<void>