@ai-sdk/mcp 1.0.64 → 1.0.66

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/mcp
 
+## 1.0.66
+
+### Patch Changes
+
+- e8d2654: Honor MCP request deadlines and support bounding or aborting client initialization.
+
+## 1.0.65
+
+### Patch Changes
+
+- Updated dependencies [9ecdefe]
+  - @ai-sdk/provider-utils@4.0.41
+
 ## 1.0.64
 
 ### Patch Changes

package/dist/index.d.mts

@@ -218,6 +218,30 @@ declare function auth(provider: OAuthClientProvider, options: {
  * Transport interface for MCP (Model Context Protocol) communication.
  * Maps to the `Transport` interface in the MCP spec.
  */
+type MCPTransportSendOptions = {
+    /**
+     * Cancels the transport operation for this message.
+     */
+    signal?: AbortSignal;
+    /**
+     * Associates an outgoing message with an incoming request.
+     */
+    relatedRequestId?: string | number;
+    /**
+     * Resumes a previously interrupted request.
+     */
+    resumptionToken?: string;
+    /**
+     * Receives updated resumption tokens from transports that support them.
+     */
+    onresumptiontoken?: (token: string) => void;
+};
+type MCPTransportCloseOptions = {
+    /**
+     * Cancels transport cleanup.
+     */
+    signal?: AbortSignal;
+};
 interface MCPTransport {
     /**
      * Initialize and start the transport
@@ -226,12 +250,14 @@ interface MCPTransport {
     /**
      * Send a JSON-RPC message through the transport
      * @param message The JSON-RPC message to send
+     * @param options Optional request-scoped cancellation options
      */
-    send(message: JSONRPCMessage): Promise<void>;
+    send(message: JSONRPCMessage, options?: MCPTransportSendOptions): Promise<void>;
     /**
      * Clean up and close the transport
+     * @param options Optional cancellation options for transport cleanup
      */
-    close(): Promise<void>;
+    close(options?: MCPTransportCloseOptions): Promise<void>;
     /**
      * Event handler for transport closure
      */
@@ -533,6 +559,10 @@ type ElicitResult = z.infer<typeof ElicitResultSchema>;
 interface MCPClientConfig {
     /** Transport configuration for connecting to the MCP server */
     transport: MCPTransportConfig | MCPTransport;
+    /**
+     * Options that bound or cancel transport startup and the initialize request.
+     */
+    initializationOptions?: RequestOptions;
     /** Optional callback for uncaught errors */
     onUncaughtError?: (error: unknown) => void;
     /**
@@ -620,4 +650,4 @@ interface MCPClient {
     close: () => Promise<void>;
 }
 
-export { type CallToolResult, type CompleteRequestParams, type CompleteResult, type Configuration, type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type ListToolsResult, type MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, type OAuthAuthorizationServerInformation, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, createMCPClient, type MCPClient as experimental_MCPClient, type ClientCapabilities as experimental_MCPClientCapabilities, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient, validateJSONRPCMessage };
+export { type CallToolResult, type CompleteRequestParams, type CompleteResult, type Configuration, type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type ListToolsResult, type MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, type MCPTransportCloseOptions, type MCPTransportSendOptions, type OAuthAuthorizationServerInformation, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, createMCPClient, type MCPClient as experimental_MCPClient, type ClientCapabilities as experimental_MCPClientCapabilities, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient, validateJSONRPCMessage };

package/dist/index.d.ts

@@ -218,6 +218,30 @@ declare function auth(provider: OAuthClientProvider, options: {
  * Transport interface for MCP (Model Context Protocol) communication.
  * Maps to the `Transport` interface in the MCP spec.
  */
+type MCPTransportSendOptions = {
+    /**
+     * Cancels the transport operation for this message.
+     */
+    signal?: AbortSignal;
+    /**
+     * Associates an outgoing message with an incoming request.
+     */
+    relatedRequestId?: string | number;
+    /**
+     * Resumes a previously interrupted request.
+     */
+    resumptionToken?: string;
+    /**
+     * Receives updated resumption tokens from transports that support them.
+     */
+    onresumptiontoken?: (token: string) => void;
+};
+type MCPTransportCloseOptions = {
+    /**
+     * Cancels transport cleanup.
+     */
+    signal?: AbortSignal;
+};
 interface MCPTransport {
     /**
      * Initialize and start the transport
@@ -226,12 +250,14 @@ interface MCPTransport {
     /**
      * Send a JSON-RPC message through the transport
      * @param message The JSON-RPC message to send
+     * @param options Optional request-scoped cancellation options
      */
-    send(message: JSONRPCMessage): Promise<void>;
+    send(message: JSONRPCMessage, options?: MCPTransportSendOptions): Promise<void>;
     /**
      * Clean up and close the transport
+     * @param options Optional cancellation options for transport cleanup
      */
-    close(): Promise<void>;
+    close(options?: MCPTransportCloseOptions): Promise<void>;
     /**
      * Event handler for transport closure
      */
@@ -533,6 +559,10 @@ type ElicitResult = z.infer<typeof ElicitResultSchema>;
 interface MCPClientConfig {
     /** Transport configuration for connecting to the MCP server */
     transport: MCPTransportConfig | MCPTransport;
+    /**
+     * Options that bound or cancel transport startup and the initialize request.
+     */
+    initializationOptions?: RequestOptions;
     /** Optional callback for uncaught errors */
     onUncaughtError?: (error: unknown) => void;
     /**
@@ -620,4 +650,4 @@ interface MCPClient {
     close: () => Promise<void>;
 }
 
-export { type CallToolResult, type CompleteRequestParams, type CompleteResult, type Configuration, type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type ListToolsResult, type MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, type OAuthAuthorizationServerInformation, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, createMCPClient, type MCPClient as experimental_MCPClient, type ClientCapabilities as experimental_MCPClientCapabilities, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient, validateJSONRPCMessage };
+export { type CallToolResult, type CompleteRequestParams, type CompleteResult, type Configuration, type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type ListToolsResult, type MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, type MCPTransportCloseOptions, type MCPTransportSendOptions, type OAuthAuthorizationServerInformation, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, createMCPClient, type MCPClient as experimental_MCPClient, type ClientCapabilities as experimental_MCPClientCapabilities, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient, validateJSONRPCMessage };

package/dist/index.js

@@ -1494,15 +1494,19 @@ var SseMCPTransport = class {
     (_b3 = this.abortController) == null ? void 0 : _b3.abort();
     (_c = this.onclose) == null ? void 0 : _c.call(this);
   }
-  async send(message) {
+  async send(message, options) {
+    var _a3, _b3;
+    (_a3 = options == null ? void 0 : options.signal) == null ? void 0 : _a3.throwIfAborted();
     if (!this.endpoint || !this.connected) {
       throw new MCPClientError({
         message: "MCP SSE Transport Error: Not connected"
       });
     }
     const endpoint = this.endpoint;
+    const transportSignal = (_b3 = this.abortController) == null ? void 0 : _b3.signal;
+    const requestSignal = (options == null ? void 0 : options.signal) == null ? transportSignal : transportSignal == null ? options.signal : AbortSignal.any([transportSignal, options.signal]);
     const attempt = async (triedAuth = false) => {
-      var _a3, _b3, _c, _d, _e;
+      var _a4, _b4, _c, _d, _e;
       try {
         const headers = await this.commonHeaders({
           "Content-Type": "application/json"
@@ -1511,7 +1515,7 @@ var SseMCPTransport = class {
           method: "POST",
           headers,
           body: JSON.stringify(message),
-          signal: (_a3 = this.abortController) == null ? void 0 : _a3.signal,
+          signal: requestSignal,
           redirect: this.redirectMode
         };
         const response = await this.fetchFn(endpoint.href, init);
@@ -1525,11 +1529,11 @@ var SseMCPTransport = class {
             });
             if (result !== "AUTHORIZED") {
               const error = new UnauthorizedError();
-              (_b3 = this.onerror) == null ? void 0 : _b3.call(this, error);
+              (_a4 = this.onerror) == null ? void 0 : _a4.call(this, error);
               return;
             }
           } catch (error) {
-            (_c = this.onerror) == null ? void 0 : _c.call(this, error);
+            (_b4 = this.onerror) == null ? void 0 : _b4.call(this, error);
             return;
           }
           return attempt(true);
@@ -1539,10 +1543,13 @@ var SseMCPTransport = class {
           const error = new MCPClientError({
             message: `MCP SSE Transport Error: POSTing to endpoint (HTTP ${response.status}): ${text}`
           });
-          (_d = this.onerror) == null ? void 0 : _d.call(this, error);
+          (_c = this.onerror) == null ? void 0 : _c.call(this, error);
           return;
         }
       } catch (error) {
+        if ((_d = options == null ? void 0 : options.signal) == null ? void 0 : _d.aborted) {
+          throw error;
+        }
         (_e = this.onerror) == null ? void 0 : _e.call(this, error);
         return;
       }
@@ -1629,27 +1636,33 @@ var HttpMCPTransport = class {
     this.abortController = new AbortController();
     this.startInboundSse();
   }
-  async close() {
-    var _a3, _b3, _c;
+  async close(options) {
+    var _a3, _b3, _c, _d, _e;
     (_a3 = this.inboundSseConnection) == null ? void 0 : _a3.close();
+    (_b3 = this.abortController) == null ? void 0 : _b3.abort();
     try {
-      if (this.sessionId && this.abortController && !this.abortController.signal.aborted) {
+      if (this.sessionId && this.abortController) {
+        (_c = options == null ? void 0 : options.signal) == null ? void 0 : _c.throwIfAborted();
         const headers = await this.commonHeaders({});
+        (_d = options == null ? void 0 : options.signal) == null ? void 0 : _d.throwIfAborted();
         await this.fetchFn(this.url.href, {
           method: "DELETE",
           headers,
-          signal: this.abortController.signal,
+          signal: options == null ? void 0 : options.signal,
           redirect: this.redirectMode
         }).catch(() => void 0);
       }
     } catch (e) {
     }
-    (_b3 = this.abortController) == null ? void 0 : _b3.abort();
-    (_c = this.onclose) == null ? void 0 : _c.call(this);
+    (_e = this.onclose) == null ? void 0 : _e.call(this);
   }
-  async send(message) {
+  async send(message, options) {
+    var _a3, _b3;
+    (_a3 = options == null ? void 0 : options.signal) == null ? void 0 : _a3.throwIfAborted();
+    const transportSignal = (_b3 = this.abortController) == null ? void 0 : _b3.signal;
+    const requestSignal = (options == null ? void 0 : options.signal) == null ? transportSignal : transportSignal == null ? options.signal : AbortSignal.any([transportSignal, options.signal]);
     const attempt = async (triedAuth = false) => {
-      var _a3, _b3, _c, _d, _e, _f, _g;
+      var _a4, _b4, _c, _d, _e, _f, _g;
       try {
         const headers = await this.commonHeaders({
           "Content-Type": "application/json",
@@ -1659,7 +1672,7 @@ var HttpMCPTransport = class {
           method: "POST",
           headers,
           body: JSON.stringify(message),
-          signal: (_a3 = this.abortController) == null ? void 0 : _a3.signal,
+          signal: requestSignal,
           redirect: this.redirectMode
         };
         const response = await this.fetchFn(this.url.href, init);
@@ -1676,7 +1689,7 @@ var HttpMCPTransport = class {
               throw error2;
             }
           } catch (error2) {
-            (_b3 = this.onerror) == null ? void 0 : _b3.call(this, error2);
+            (_a4 = this.onerror) == null ? void 0 : _a4.call(this, error2);
             throw error2;
           }
           return attempt(true);
@@ -1699,7 +1712,7 @@ var HttpMCPTransport = class {
             url: this.url.href,
             responseBody: text != null ? text : void 0
           });
-          (_c = this.onerror) == null ? void 0 : _c.call(this, error2);
+          (_b4 = this.onerror) == null ? void 0 : _b4.call(this, error2);
           throw error2;
         }
         const isNotification = !("id" in message);
@@ -1711,7 +1724,7 @@ var HttpMCPTransport = class {
           const data = await response.json();
           const messages = Array.isArray(data) ? data.map((message2) => validateJSONRPCMessage(message2)) : [validateJSONRPCMessage(data)];
           for (const jsonRpcMessage of messages) {
-            (_d = this.onmessage) == null ? void 0 : _d.call(this, jsonRpcMessage);
+            (_c = this.onmessage) == null ? void 0 : _c.call(this, jsonRpcMessage);
           }
           return;
         }
@@ -1722,13 +1735,13 @@ var HttpMCPTransport = class {
               statusCode: response.status,
               url: this.url.href
             });
-            (_e = this.onerror) == null ? void 0 : _e.call(this, error2);
+            (_d = this.onerror) == null ? void 0 : _d.call(this, error2);
             throw error2;
           }
           const stream = response.body.pipeThrough(new TextDecoderStream()).pipeThrough(new import_provider_utils4.EventSourceParserStream());
           const reader = stream.getReader();
           const processEvents = async () => {
-            var _a4, _b4, _c2;
+            var _a5, _b5, _c2, _d2;
             try {
               while (true) {
                 const { done, value } = await reader.read();
@@ -1737,29 +1750,29 @@ var HttpMCPTransport = class {
                 if (isMessageEvent2(event)) {
                   try {
                     const msg = await parseJSONRPCMessage(data);
-                    (_a4 = this.onmessage) == null ? void 0 : _a4.call(this, msg);
+                    (_a5 = this.onmessage) == null ? void 0 : _a5.call(this, msg);
                   } catch (error2) {
                     const e = new MCPClientError({
                       message: "MCP HTTP Transport Error: Failed to parse message",
                       cause: error2
                     });
-                    (_b4 = this.onerror) == null ? void 0 : _b4.call(this, e);
+                    (_b5 = this.onerror) == null ? void 0 : _b5.call(this, e);
                   }
                 }
               }
             } catch (error2) {
-              if (error2 instanceof Error && error2.name === "AbortError") {
+              if (((_c2 = options == null ? void 0 : options.signal) == null ? void 0 : _c2.aborted) || error2 instanceof Error && error2.name === "AbortError") {
                 return;
               }
-              (_c2 = this.onerror) == null ? void 0 : _c2.call(this, error2);
+              (_d2 = this.onerror) == null ? void 0 : _d2.call(this, error2);
             }
           };
           void processEvents().catch((error2) => {
-            var _a4;
-            if (error2 instanceof Error && error2.name === "AbortError") {
+            var _a5, _b5;
+            if (((_a5 = options == null ? void 0 : options.signal) == null ? void 0 : _a5.aborted) || error2 instanceof Error && error2.name === "AbortError") {
               return;
             }
-            (_a4 = this.onerror) == null ? void 0 : _a4.call(this, error2);
+            (_b5 = this.onerror) == null ? void 0 : _b5.call(this, error2);
           });
           return;
         }
@@ -1768,9 +1781,12 @@ var HttpMCPTransport = class {
           statusCode: response.status,
           url: this.url.href
         });
-        (_f = this.onerror) == null ? void 0 : _f.call(this, error);
+        (_e = this.onerror) == null ? void 0 : _e.call(this, error);
         throw error;
       } catch (error) {
+        if ((_f = options == null ? void 0 : options.signal) == null ? void 0 : _f.aborted) {
+          throw error;
+        }
         (_g = this.onerror) == null ? void 0 : _g.call(this, error);
         throw error;
       }
@@ -2001,6 +2017,44 @@ function prepareMaxRetries(maxRetries) {
   }
   return maxRetries;
 }
+function getEffectiveTimeout({
+  timeout,
+  maxTotalTimeout
+}) {
+  if (timeout == null) {
+    return maxTotalTimeout;
+  }
+  if (maxTotalTimeout == null) {
+    return timeout;
+  }
+  return Math.min(timeout, maxTotalTimeout);
+}
+function waitForAbort(promise, signal) {
+  if (signal == null) {
+    return promise;
+  }
+  return new Promise((resolve, reject) => {
+    const cleanup = () => {
+      signal.removeEventListener("abort", onAbort);
+    };
+    const onAbort = () => {
+      cleanup();
+      reject(signal.reason);
+    };
+    if (signal.aborted) {
+      onAbort();
+      return;
+    }
+    signal.addEventListener("abort", onAbort, { once: true });
+    promise.then((value) => {
+      cleanup();
+      resolve(value);
+    }).catch((error) => {
+      cleanup();
+      reject(error);
+    });
+  });
+}
 function mcpToModelOutput({
   output
 }) {
@@ -2038,7 +2092,8 @@ var DefaultMCPClient = class {
     version = CLIENT_VERSION,
     onUncaughtError,
     maxRetries,
-    capabilities
+    capabilities,
+    initializationOptions
   }) {
     this.requestMessageId = 0;
     this.responseHandlers = /* @__PURE__ */ new Map();
@@ -2048,6 +2103,7 @@ var DefaultMCPClient = class {
     this.onUncaughtError = onUncaughtError;
     this.maxRetries = prepareMaxRetries(maxRetries);
     this.clientCapabilities = capabilities != null ? capabilities : {};
+    this.initializationOptions = initializationOptions;
     if (isCustomMcpTransport(transportConfig)) {
       this.transport = transportConfig;
     } else {
@@ -2082,9 +2138,25 @@ var DefaultMCPClient = class {
     return this._serverInstructions;
   }
   async init() {
+    var _a3;
+    const externalSignal = (_a3 = this.initializationOptions) == null ? void 0 : _a3.signal;
+    const timeout = this.initializationOptions ? getEffectiveTimeout(this.initializationOptions) : void 0;
+    const timeoutController = timeout == null ? void 0 : new AbortController();
+    const signal = externalSignal == null ? timeoutController == null ? void 0 : timeoutController.signal : timeoutController == null ? externalSignal : AbortSignal.any([externalSignal, timeoutController.signal]);
+    let timeoutId;
+    let timeoutError;
+    if (timeout != null) {
+      timeoutId = setTimeout(() => {
+        timeoutError = new MCPClientError({
+          message: `MCP client initialization timed out after ${timeout}ms`
+        });
+        timeoutController == null ? void 0 : timeoutController.abort(timeoutError);
+      }, timeout);
+    }
     try {
-      await this.transport.start();
       this.isClosed = false;
+      signal == null ? void 0 : signal.throwIfAborted();
+      await waitForAbort(this.transport.start(), signal);
       const result = await this.request({
         request: {
           method: "initialize",
@@ -2094,7 +2166,8 @@ var DefaultMCPClient = class {
             clientInfo: this.clientInfo
           }
         },
-        resultSchema: InitializeResultSchema
+        resultSchema: InitializeResultSchema,
+        options: { signal }
       });
       if (result === void 0) {
         throw new MCPClientError({
@@ -2114,13 +2187,33 @@ var DefaultMCPClient = class {
         this.transport.protocolVersion = result.protocolVersion;
       }
       this._serverInstructions = result.instructions;
-      await this.notification({
-        method: "notifications/initialized"
-      });
+      await this.notification(
+        {
+          method: "notifications/initialized"
+        },
+        { signal }
+      );
       return this;
     } catch (error) {
-      await this.close();
+      try {
+        await waitForAbort(this.transport.close({ signal }), signal);
+      } catch (e) {
+      }
+      this.onClose();
+      if (timeoutError != null) {
+        throw timeoutError;
+      }
+      if (externalSignal == null ? void 0 : externalSignal.aborted) {
+        throw new MCPClientError({
+          message: "MCP client initialization was aborted",
+          cause: externalSignal.reason
+        });
+      }
       throw error;
+    } finally {
+      if (timeoutId != null) {
+        clearTimeout(timeoutId);
+      }
     }
   }
   async close() {
@@ -2129,6 +2222,12 @@ var DefaultMCPClient = class {
     await ((_a3 = this.transport) == null ? void 0 : _a3.close());
     this.onClose();
   }
+  send(message, signal) {
+    return this.transport.send(
+      message,
+      signal == null ? void 0 : { signal }
+    );
+  }
   assertCapability(method) {
     switch (method) {
       case "initialize":
@@ -2187,6 +2286,10 @@ var DefaultMCPClient = class {
       this.assertCapability(request.method);
       const signal = options == null ? void 0 : options.signal;
       signal == null ? void 0 : signal.throwIfAborted();
+      const timeout = options == null ? void 0 : getEffectiveTimeout(options);
+      const timeoutController = timeout == null ? void 0 : new AbortController();
+      const transportSignal = signal == null ? timeoutController == null ? void 0 : timeoutController.signal : timeoutController == null ? signal : AbortSignal.any([signal, timeoutController.signal]);
+      let timeoutId;
       const messageId = this.requestMessageId++;
       const jsonrpcRequest = {
         ...request,
@@ -2204,6 +2307,9 @@ var DefaultMCPClient = class {
       const cleanup = () => {
         this.responseHandlers.delete(messageId);
         signal == null ? void 0 : signal.removeEventListener("abort", onAbort);
+        if (timeoutId != null) {
+          clearTimeout(timeoutId);
+        }
       };
       const rejectAndCleanup = (error) => {
         cleanup();
@@ -2213,6 +2319,13 @@ var DefaultMCPClient = class {
         cleanup();
         rejectWithAbortError();
       };
+      const onTimeout = () => {
+        const error = new MCPClientError({
+          message: `Request timed out after ${timeout}ms`
+        });
+        timeoutController == null ? void 0 : timeoutController.abort(error);
+        rejectAndCleanup(error);
+      };
       this.responseHandlers.set(messageId, (response) => {
         if (signal == null ? void 0 : signal.aborted) {
           cleanup();
@@ -2234,7 +2347,11 @@ var DefaultMCPClient = class {
         }
       });
       signal == null ? void 0 : signal.addEventListener("abort", onAbort, { once: true });
-      this.transport.send(jsonrpcRequest).catch((error) => {
+      if (timeout != null) {
+        timeoutId = setTimeout(onTimeout, timeout);
+      }
+      const sendPromise = transportSignal == null ? this.transport.send(jsonrpcRequest) : this.send(jsonrpcRequest, transportSignal);
+      sendPromise.catch((error) => {
         rejectAndCleanup(error);
       });
     });
@@ -2369,12 +2486,15 @@ var DefaultMCPClient = class {
       options
     });
   }
-  async notification(notification) {
+  async notification(notification, options) {
     const jsonrpcNotification = {
       ...notification,
       jsonrpc: "2.0"
     };
-    await this.transport.send(jsonrpcNotification);
+    await waitForAbort(
+      this.send(jsonrpcNotification, options == null ? void 0 : options.signal),
+      options == null ? void 0 : options.signal
+    );
   }
   /**
    * Returns a set of AI SDK tools from the MCP server.