MCP TypeScript SDK (V2)
    Preparing search index...

    Class SSEServerTransport

    Server transport for SSE: this will send messages over an SSE connection and receive messages from HTTP POST requests.

    This transport is only available in Node.js environments.

    Use StreamableHTTPServerTransport from @modelcontextprotocol/server instead.

    Implements

    Index

    Constructors

    constructor

    Properties

    onclose? onerror? onmessage?

    Accessors

    sessionId

    Methods

    close handleMessage handlePostMessage send start

    Constructors

    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?: <T extends JSONRPCMessage>(
        message: T,
        extra?: MessageExtraInfo,
    ) => void

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

    Includes the request and authInfo if the transport is authenticated.

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

    Accessors

    Methods

    • Parameters

      • req: IncomingMessage & { auth?: AuthInfo }
      • res: ServerResponse
      • OptionalparsedBody: unknown

      Returns Promise<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 or Server classes, as they will implicitly call start().

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods