@modelcontextprotocol/sdk
    Preparing search index...

    Interface StreamableHTTPServerTransportOptions

    Configuration options for StreamableHTTPServerTransport

    interface StreamableHTTPServerTransportOptions {
        allowedHosts?: string[];
        allowedOrigins?: string[];
        enableDnsRebindingProtection?: boolean;
        enableJsonResponse?: boolean;
        eventStore?: EventStore;
        onsessioninitialized?: (sessionId: string) => void;
        sessionIdGenerator: (() => string) | undefined;
    }
    Index

    Properties

    allowedHosts? allowedOrigins? enableDnsRebindingProtection? enableJsonResponse? eventStore? onsessioninitialized? sessionIdGenerator

    Properties

    allowedHosts?: string[]

    List of allowed host header values for DNS rebinding protection. If not specified, host validation is disabled.

    allowedOrigins?: string[]

    List of allowed origin header values for DNS rebinding protection. If not specified, origin validation is disabled.

    enableDnsRebindingProtection?: boolean

    Enable DNS rebinding protection (requires allowedHosts and/or allowedOrigins to be configured). Default is false for backwards compatibility.

    enableJsonResponse?: boolean

    If true, the server will return JSON responses instead of starting an SSE stream. This can be useful for simple request/response scenarios without streaming. Default is false (SSE streams are preferred).

    eventStore?: EventStore

    Event store for resumability support If provided, resumability will be enabled, allowing clients to reconnect and resume messages

    onsessioninitialized?: (sessionId: string) => void

    A callback for session initialization events This is called when the server initializes a new session. Useful in cases when you need to register multiple mcp sessions and need to keep track of them.

    Type Declaration

      • (sessionId: string): void

      • Parameters

        • sessionId: string

          The generated session ID

        Returns void

    sessionIdGenerator: (() => string) | undefined

    Function that generates a session ID for the transport. The session ID SHOULD be globally unique and cryptographically secure (e.g., a securely generated UUID, a JWT, or a cryptographic hash)

    Return undefined to disable session management.

    Settings

    Member Visibility

    On This Page

    Properties