@modelcontextprotocol/sdk 1.24.2 → 1.25.0

package/dist/cjs/server/streamableHttp.d.ts

@@ -1,106 +1,30 @@
+/**
+ * Node.js HTTP Streamable HTTP Server Transport
+ *
+ * This is a thin wrapper around `WebStandardStreamableHTTPServerTransport` that provides
+ * compatibility with Node.js HTTP server (IncomingMessage/ServerResponse).
+ *
+ * For web-standard environments (Cloudflare Workers, Deno, Bun), use `WebStandardStreamableHTTPServerTransport` directly.
+ */
 import { IncomingMessage, ServerResponse } from 'node:http';
 import { Transport } from '../shared/transport.js';
-import { MessageExtraInfo, JSONRPCMessage, RequestId } from '../types.js';
 import { AuthInfo } from './auth/types.js';
-export type StreamId = string;
-export type EventId = string;
-/**
- * Interface for resumability support via event storage
- */
-export interface EventStore {
-    /**
-     * Stores an event for later retrieval
-     * @param streamId ID of the stream the event belongs to
-     * @param message The JSON-RPC message to store
-     * @returns The generated event ID for the stored event
-     */
-    storeEvent(streamId: StreamId, message: JSONRPCMessage): Promise<EventId>;
-    /**
-     * Get the stream ID associated with a given event ID.
-     * @param eventId The event ID to look up
-     * @returns The stream ID, or undefined if not found
-     *
-     * Optional: If not provided, the SDK will use the streamId returned by
-     * replayEventsAfter for stream mapping.
-     */
-    getStreamIdForEventId?(eventId: EventId): Promise<StreamId | undefined>;
-    replayEventsAfter(lastEventId: EventId, { send }: {
-        send: (eventId: EventId, message: JSONRPCMessage) => Promise<void>;
-    }): Promise<StreamId>;
-}
+import { MessageExtraInfo, JSONRPCMessage, RequestId } from '../types.js';
+import { WebStandardStreamableHTTPServerTransportOptions, EventStore, StreamId, EventId } from './webStandardStreamableHttp.js';
+export type { EventStore, StreamId, EventId };
 /**
  * Configuration options for StreamableHTTPServerTransport
+ *
+ * This is an alias for WebStandardStreamableHTTPServerTransportOptions for backward compatibility.
  */
-export interface StreamableHTTPServerTransportOptions {
-    /**
-     * 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.
-     */
-    sessionIdGenerator: (() => string) | undefined;
-    /**
-     * 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.
-     * @param sessionId The generated session ID
-     */
-    onsessioninitialized?: (sessionId: string) => void | Promise<void>;
-    /**
-     * A callback for session close events
-     * This is called when the server closes a session due to a DELETE request.
-     * Useful in cases when you need to clean up resources associated with the session.
-     * Note that this is different from the transport closing, if you are handling
-     * HTTP requests from multiple nodes you might want to close each
-     * StreamableHTTPServerTransport after a request is completed while still keeping the
-     * session open/running.
-     * @param sessionId The session ID that was closed
-     */
-    onsessionclosed?: (sessionId: string) => void | Promise<void>;
-    /**
-     * 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).
-     */
-    enableJsonResponse?: boolean;
-    /**
-     * Event store for resumability support
-     * If provided, resumability will be enabled, allowing clients to reconnect and resume messages
-     */
-    eventStore?: EventStore;
-    /**
-     * List of allowed host header values for DNS rebinding protection.
-     * If not specified, host validation is disabled.
-     * @deprecated Use the `hostHeaderValidation` middleware from `@modelcontextprotocol/sdk/server/middleware/hostHeaderValidation.js` instead,
-     * or use `createMcpExpressApp` from `@modelcontextprotocol/sdk/server/express.js` which includes localhost protection by default.
-     */
-    allowedHosts?: string[];
-    /**
-     * List of allowed origin header values for DNS rebinding protection.
-     * If not specified, origin validation is disabled.
-     * @deprecated Use the `hostHeaderValidation` middleware from `@modelcontextprotocol/sdk/server/middleware/hostHeaderValidation.js` instead,
-     * or use `createMcpExpressApp` from `@modelcontextprotocol/sdk/server/express.js` which includes localhost protection by default.
-     */
-    allowedOrigins?: string[];
-    /**
-     * Enable DNS rebinding protection (requires allowedHosts and/or allowedOrigins to be configured).
-     * Default is false for backwards compatibility.
-     * @deprecated Use the `hostHeaderValidation` middleware from `@modelcontextprotocol/sdk/server/middleware/hostHeaderValidation.js` instead,
-     * or use `createMcpExpressApp` from `@modelcontextprotocol/sdk/server/express.js` which includes localhost protection by default.
-     */
-    enableDnsRebindingProtection?: boolean;
-    /**
-     * Retry interval in milliseconds to suggest to clients in SSE retry field.
-     * When set, the server will send a retry field in SSE priming events to control
-     * client reconnection timing for polling behavior.
-     */
-    retryInterval?: number;
-}
+export type StreamableHTTPServerTransportOptions = WebStandardStreamableHTTPServerTransportOptions;
 /**
  * Server transport for Streamable HTTP: this implements the MCP Streamable HTTP transport specification.
  * It supports both SSE streaming and direct HTTP responses.
  *
+ * This is a wrapper around `WebStandardStreamableHTTPServerTransport` that provides Node.js HTTP compatibility.
+ * It uses the `@hono/node-server` library to convert between Node.js HTTP and Web Standard APIs.
+ *
  * Usage example:
  *
  * ```typescript
@@ -132,79 +56,57 @@ export interface StreamableHTTPServerTransportOptions {
  * - No session validation is performed
  */
 export declare class StreamableHTTPServerTransport implements Transport {
-    private sessionIdGenerator;
-    private _started;
-    private _streamMapping;
-    private _requestToStreamMapping;
-    private _requestResponseMap;
-    private _initialized;
-    private _enableJsonResponse;
-    private _standaloneSseStreamId;
-    private _eventStore?;
-    private _onsessioninitialized?;
-    private _onsessionclosed?;
-    private _allowedHosts?;
-    private _allowedOrigins?;
-    private _enableDnsRebindingProtection;
-    private _retryInterval?;
-    sessionId?: string;
-    onclose?: () => void;
-    onerror?: (error: Error) => void;
-    onmessage?: (message: JSONRPCMessage, extra?: MessageExtraInfo) => void;
-    constructor(options: StreamableHTTPServerTransportOptions);
-    /**
-     * Starts the transport. This is required by the Transport interface but is a no-op
-     * for the Streamable HTTP transport as connections are managed per-request.
-     */
-    start(): Promise<void>;
-    /**
-     * Validates request headers for DNS rebinding protection.
-     * @returns Error message if validation fails, undefined if validation passes.
-     */
-    private validateRequestHeaders;
-    /**
-     * Handles an incoming HTTP request, whether GET or POST
-     */
-    handleRequest(req: IncomingMessage & {
-        auth?: AuthInfo;
-    }, res: ServerResponse, parsedBody?: unknown): Promise<void>;
+    private _webStandardTransport;
+    private _requestListener;
+    private _requestContext;
+    constructor(options?: StreamableHTTPServerTransportOptions);
     /**
-     * Writes a priming event to establish resumption capability.
-     * Only sends if eventStore is configured (opt-in for resumability).
+     * Gets the session ID for this transport instance.
      */
-    private _maybeWritePrimingEvent;
+    get sessionId(): string | undefined;
     /**
-     * Handles GET requests for SSE stream
+     * Sets callback for when the transport is closed.
      */
-    private handleGetRequest;
+    set onclose(handler: (() => void) | undefined);
+    get onclose(): (() => void) | undefined;
     /**
-     * Replays events that would have been sent after the specified event ID
-     * Only used when resumability is enabled
+     * Sets callback for transport errors.
      */
-    private replayEvents;
+    set onerror(handler: ((error: Error) => void) | undefined);
+    get onerror(): ((error: Error) => void) | undefined;
     /**
-     * Writes an event to the SSE stream with proper formatting
+     * Sets callback for incoming messages.
      */
-    private writeSSEEvent;
+    set onmessage(handler: ((message: JSONRPCMessage, extra?: MessageExtraInfo) => void) | undefined);
+    get onmessage(): ((message: JSONRPCMessage, extra?: MessageExtraInfo) => void) | undefined;
     /**
-     * Handles unsupported requests (PUT, PATCH, etc.)
+     * Starts the transport. This is required by the Transport interface but is a no-op
+     * for the Streamable HTTP transport as connections are managed per-request.
      */
-    private handleUnsupportedRequest;
+    start(): Promise<void>;
     /**
-     * Handles POST requests containing JSON-RPC messages
+     * Closes the transport and all active connections.
      */
-    private handlePostRequest;
+    close(): Promise<void>;
     /**
-     * Handles DELETE requests to terminate sessions
+     * Sends a JSON-RPC message through the transport.
      */
-    private handleDeleteRequest;
+    send(message: JSONRPCMessage, options?: {
+        relatedRequestId?: RequestId;
+    }): Promise<void>;
     /**
-     * Validates session ID for non-initialization requests
-     * Returns true if the session is valid, false otherwise
+     * Handles an incoming HTTP request, whether GET or POST.
+     *
+     * This method converts Node.js HTTP objects to Web Standard Request/Response
+     * and delegates to the underlying WebStandardStreamableHTTPServerTransport.
+     *
+     * @param req - Node.js IncomingMessage, optionally with auth property from middleware
+     * @param res - Node.js ServerResponse
+     * @param parsedBody - Optional pre-parsed body from body-parser middleware
      */
-    private validateSession;
-    private validateProtocolVersion;
-    close(): Promise<void>;
+    handleRequest(req: IncomingMessage & {
+        auth?: AuthInfo;
+    }, res: ServerResponse, parsedBody?: unknown): Promise<void>;
     /**
      * Close an SSE stream for a specific request, triggering client reconnection.
      * Use this to implement polling behavior during long-running operations -
@@ -216,8 +118,5 @@ export declare class StreamableHTTPServerTransport implements Transport {
      * Use this to implement polling behavior for server-initiated notifications.
      */
     closeStandaloneSSEStream(): void;
-    send(message: JSONRPCMessage, options?: {
-        relatedRequestId?: RequestId;
-    }): Promise<void>;
 }
 //# sourceMappingURL=streamableHttp.d.ts.map

package/dist/cjs/server/streamableHttp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streamableHttp.d.ts","sourceRoot":"","sources":["../../../src/server/streamableHttp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EACH,gBAAgB,EAMhB,cAAc,EAEd,SAAS,EAGZ,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI3C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1E;;;;;;;OAOG;IACH,qBAAqB,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;IAExE,iBAAiB,CACb,WAAW,EAAE,OAAO,EACpB,EACI,IAAI,EACP,EAAE;QACC,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KACtE,GACF,OAAO,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACjD;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;;OAKG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,6BAA8B,YAAW,SAAS;IAE3D,OAAO,CAAC,kBAAkB,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAkB;IAClC,OAAO,CAAC,cAAc,CAA0C;IAChE,OAAO,CAAC,uBAAuB,CAAqC;IACpE,OAAO,CAAC,mBAAmB,CAA6C;IACxE,OAAO,CAAC,YAAY,CAAkB;IACtC,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,sBAAsB,CAAyB;IACvD,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,OAAO,CAAC,qBAAqB,CAAC,CAA8C;IAC5E,OAAO,CAAC,gBAAgB,CAAC,CAA8C;IACvE,OAAO,CAAC,aAAa,CAAC,CAAW;IACjC,OAAO,CAAC,eAAe,CAAC,CAAW;IACnC,OAAO,CAAC,6BAA6B,CAAU;IAC/C,OAAO,CAAC,cAAc,CAAC,CAAS;IAEhC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC;gBAE5D,OAAO,EAAE,oCAAoC;IAYzD;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAO5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAyB9B;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,eAAe,GAAG;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,EAAE,GAAG,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BzH;;;OAGG;YACW,uBAAuB;IAcrC;;OAEG;YACW,gBAAgB;IAiF9B;;;OAGG;YACW,YAAY;IA6E1B;;OAEG;IACH,OAAO,CAAC,aAAa;IAWrB;;OAEG;YACW,wBAAwB;IAetC;;OAEG;YACW,iBAAiB;IAqM/B;;OAEG;YACW,mBAAmB;IAYjC;;;OAGG;IACH,OAAO,CAAC,eAAe;IAkEvB,OAAO,CAAC,uBAAuB;IAsBzB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAW1C;;;OAGG;IACH,wBAAwB,IAAI,IAAI;IAQ1B,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAiGjG"}
+{"version":3,"file":"streamableHttp.d.ts","sourceRoot":"","sources":["../../../src/server/streamableHttp.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAEH,+CAA+C,EAC/C,UAAU,EACV,QAAQ,EACR,OAAO,EACV,MAAM,gCAAgC,CAAC;AAGxC,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAE9C;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG,+CAA+C,CAAC;AAEnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,6BAA8B,YAAW,SAAS;IAC3D,OAAO,CAAC,qBAAqB,CAA2C;IACxE,OAAO,CAAC,gBAAgB,CAAwC;IAEhE,OAAO,CAAC,eAAe,CAAkF;gBAE7F,OAAO,GAAE,oCAAyC;IAe9D;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED;;OAEG;IACH,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAE5C;IAED,IAAI,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAEtC;IAED;;OAEG;IACH,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,SAAS,EAExD;IAED,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,SAAS,CAElD;IAED;;OAEG;IACH,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC,GAAG,SAAS,EAE/F;IAED,IAAI,SAAS,IAAI,CAAC,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,gBAAgB,KAAK,IAAI,CAAC,GAAG,SAAS,CAEzF;IAED;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9F;;;;;;;;;OASG;IACG,aAAa,CAAC,GAAG,EAAE,eAAe,GAAG;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,EAAE,GAAG,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBzH;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAI1C;;;OAGG;IACH,wBAAwB,IAAI,IAAI;CAGnC"}