@ai-sdk/mcp 0.0.7 → 0.0.9

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/mcp
 
+## 0.0.9
+
+### Patch Changes
+
+- 89b59d7: feat(mcp): add client elicitation support
+
+## 0.0.8
+
+### Patch Changes
+
+- Updated dependencies [056c471]
+  - @ai-sdk/provider-utils@3.0.17
+
 ## 0.0.7
 
 ### Patch Changes

package/dist/index.d.mts

@@ -270,6 +270,12 @@ type RequestOptions = {
     timeout?: number;
     maxTotalTimeout?: number;
 };
+declare const ClientCapabilitiesSchema: z.ZodObject<{
+    elicitation: z.ZodOptional<z.ZodObject<{
+        applyDefaults: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+type ClientCapabilities = z.infer<typeof ClientCapabilitiesSchema>;
 type PaginatedRequest = Request & {
     params?: BaseParams & {
         cursor?: string;
@@ -393,6 +399,21 @@ declare const GetPromptResultSchema: z.ZodObject<{
     }, z.core.$loose>>;
 }, z.core.$loose>;
 type GetPromptResult = z.infer<typeof GetPromptResultSchema>;
+declare const ElicitationRequestSchema: z.ZodObject<{
+    method: z.ZodLiteral<"elicitation/create">;
+    params: z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+        message: z.ZodString;
+        requestedSchema: z.ZodUnknown;
+    }, z.core.$loose>;
+}, z.core.$strip>;
+type ElicitationRequest = z.infer<typeof ElicitationRequestSchema>;
+declare const ElicitResultSchema: z.ZodObject<{
+    _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    action: z.ZodUnion<readonly [z.ZodLiteral<"accept">, z.ZodLiteral<"decline">, z.ZodLiteral<"cancel">]>;
+    content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;
+type ElicitResult = z.infer<typeof ElicitResultSchema>;
 
 interface MCPClientConfig {
     /** Transport configuration for connecting to the MCP server */
@@ -401,6 +422,12 @@ interface MCPClientConfig {
     onUncaughtError?: (error: unknown) => void;
     /** Optional client name, defaults to 'ai-sdk-mcp-client' */
     name?: string;
+    /**
+     * Optional client capabilities to advertise during initialization
+     *
+     * NOTE: It is up to the client application to handle the requests properly. This parameter just helps surface the request from the server
+     */
+    capabilities?: ClientCapabilities;
 }
 declare function createMCPClient(config: MCPClientConfig): Promise<MCPClient>;
 interface MCPClient {
@@ -427,7 +454,8 @@ interface MCPClient {
         arguments?: Record<string, unknown>;
         options?: RequestOptions;
     }): Promise<GetPromptResult>;
+    onElicitationRequest(schema: typeof ElicitationRequestSchema, handler: (request: ElicitationRequest) => Promise<ElicitResult> | ElicitResult): void;
     close: () => Promise<void>;
 }
 
-export { type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type MCPTransport, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, type MCPClient as experimental_MCPClient, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient };
+export { type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type MCPTransport, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, type MCPClient as experimental_MCPClient, type ClientCapabilities as experimental_MCPClientCapabilities, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient };

package/dist/index.d.ts

@@ -270,6 +270,12 @@ type RequestOptions = {
     timeout?: number;
     maxTotalTimeout?: number;
 };
+declare const ClientCapabilitiesSchema: z.ZodObject<{
+    elicitation: z.ZodOptional<z.ZodObject<{
+        applyDefaults: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+type ClientCapabilities = z.infer<typeof ClientCapabilitiesSchema>;
 type PaginatedRequest = Request & {
     params?: BaseParams & {
         cursor?: string;
@@ -393,6 +399,21 @@ declare const GetPromptResultSchema: z.ZodObject<{
     }, z.core.$loose>>;
 }, z.core.$loose>;
 type GetPromptResult = z.infer<typeof GetPromptResultSchema>;
+declare const ElicitationRequestSchema: z.ZodObject<{
+    method: z.ZodLiteral<"elicitation/create">;
+    params: z.ZodObject<{
+        _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+        message: z.ZodString;
+        requestedSchema: z.ZodUnknown;
+    }, z.core.$loose>;
+}, z.core.$strip>;
+type ElicitationRequest = z.infer<typeof ElicitationRequestSchema>;
+declare const ElicitResultSchema: z.ZodObject<{
+    _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    action: z.ZodUnion<readonly [z.ZodLiteral<"accept">, z.ZodLiteral<"decline">, z.ZodLiteral<"cancel">]>;
+    content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$loose>;
+type ElicitResult = z.infer<typeof ElicitResultSchema>;
 
 interface MCPClientConfig {
     /** Transport configuration for connecting to the MCP server */
@@ -401,6 +422,12 @@ interface MCPClientConfig {
     onUncaughtError?: (error: unknown) => void;
     /** Optional client name, defaults to 'ai-sdk-mcp-client' */
     name?: string;
+    /**
+     * Optional client capabilities to advertise during initialization
+     *
+     * NOTE: It is up to the client application to handle the requests properly. This parameter just helps surface the request from the server
+     */
+    capabilities?: ClientCapabilities;
 }
 declare function createMCPClient(config: MCPClientConfig): Promise<MCPClient>;
 interface MCPClient {
@@ -427,7 +454,8 @@ interface MCPClient {
         arguments?: Record<string, unknown>;
         options?: RequestOptions;
     }): Promise<GetPromptResult>;
+    onElicitationRequest(schema: typeof ElicitationRequestSchema, handler: (request: ElicitationRequest) => Promise<ElicitResult> | ElicitResult): void;
     close: () => Promise<void>;
 }
 
-export { type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type MCPTransport, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, type MCPClient as experimental_MCPClient, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient };
+export { type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type MCPTransport, type OAuthClientInformation, type OAuthClientMetadata, type OAuthClientProvider, type OAuthTokens, UnauthorizedError, auth, type MCPClient as experimental_MCPClient, type ClientCapabilities as experimental_MCPClientCapabilities, type MCPClientConfig as experimental_MCPClientConfig, createMCPClient as experimental_createMCPClient };

package/dist/index.js

@@ -30,6 +30,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  ElicitResultSchema: () => ElicitResultSchema,
+  ElicitationRequestSchema: () => ElicitationRequestSchema,
   UnauthorizedError: () => UnauthorizedError,
   auth: () => auth,
   experimental_createMCPClient: () => createMCPClient
@@ -89,6 +91,9 @@ var RequestSchema = import_v4.z.object({
   method: import_v4.z.string(),
   params: import_v4.z.optional(BaseParamsSchema)
 });
+var ElicitationCapabilitySchema = import_v4.z.object({
+  applyDefaults: import_v4.z.optional(import_v4.z.boolean())
+}).loose();
 var ServerCapabilitiesSchema = import_v4.z.looseObject({
   experimental: import_v4.z.optional(import_v4.z.object({}).loose()),
   logging: import_v4.z.optional(import_v4.z.object({}).loose()),
@@ -107,8 +112,12 @@ var ServerCapabilitiesSchema = import_v4.z.looseObject({
     import_v4.z.looseObject({
       listChanged: import_v4.z.optional(import_v4.z.boolean())
     })
-  )
+  ),
+  elicitation: import_v4.z.optional(ElicitationCapabilitySchema)
 });
+var ClientCapabilitiesSchema = import_v4.z.object({
+  elicitation: import_v4.z.optional(ElicitationCapabilitySchema)
+}).loose();
 var InitializeResultSchema = ResultSchema.extend({
   protocolVersion: import_v4.z.string(),
   capabilities: ServerCapabilitiesSchema,
@@ -228,6 +237,22 @@ var GetPromptResultSchema = ResultSchema.extend({
   description: import_v4.z.optional(import_v4.z.string()),
   messages: import_v4.z.array(PromptMessageSchema)
 });
+var ElicitationRequestParamsSchema = BaseParamsSchema.extend({
+  message: import_v4.z.string(),
+  requestedSchema: import_v4.z.unknown()
+});
+var ElicitationRequestSchema = RequestSchema.extend({
+  method: import_v4.z.literal("elicitation/create"),
+  params: ElicitationRequestParamsSchema
+});
+var ElicitResultSchema = ResultSchema.extend({
+  action: import_v4.z.union([
+    import_v4.z.literal("accept"),
+    import_v4.z.literal("decline"),
+    import_v4.z.literal("cancel")
+  ]),
+  content: import_v4.z.optional(import_v4.z.record(import_v4.z.string(), import_v4.z.unknown()))
+});
 
 // src/tool/json-rpc-message.ts
 var JSONRPC_VERSION = "2.0";
@@ -1546,13 +1571,15 @@ var DefaultMCPClient = class {
   constructor({
     transport: transportConfig,
     name: name3 = "ai-sdk-mcp-client",
-    onUncaughtError
+    onUncaughtError,
+    capabilities
   }) {
     this.requestMessageId = 0;
     this.responseHandlers = /* @__PURE__ */ new Map();
     this.serverCapabilities = {};
     this.isClosed = true;
     this.onUncaughtError = onUncaughtError;
+    this.clientCapabilities = capabilities != null ? capabilities : {};
     if (isCustomMcpTransport(transportConfig)) {
       this.transport = transportConfig;
     } else {
@@ -1562,11 +1589,15 @@ var DefaultMCPClient = class {
     this.transport.onerror = (error) => this.onError(error);
     this.transport.onmessage = (message) => {
       if ("method" in message) {
-        this.onError(
-          new MCPClientError({
-            message: "Unsupported message type"
-          })
-        );
+        if ("id" in message) {
+          this.onRequestMessage(message);
+        } else {
+          this.onError(
+            new MCPClientError({
+              message: "Unsupported message type"
+            })
+          );
+        }
         return;
       }
       this.onResponse(message);
@@ -1585,7 +1616,7 @@ var DefaultMCPClient = class {
           method: "initialize",
           params: {
             protocolVersion: LATEST_PROTOCOL_VERSION,
-            capabilities: {},
+            capabilities: this.clientCapabilities,
             clientInfo: this.clientInfo
           }
         },
@@ -1885,6 +1916,77 @@ var DefaultMCPClient = class {
   }) {
     return this.getPromptInternal({ name: name3, args, options });
   }
+  onElicitationRequest(schema, handler) {
+    if (schema !== ElicitationRequestSchema) {
+      throw new MCPClientError({
+        message: "Unsupported request schema. Only ElicitationRequestSchema is supported."
+      });
+    }
+    this.elicitationRequestHandler = handler;
+  }
+  async onRequestMessage(request) {
+    try {
+      if (request.method !== "elicitation/create") {
+        await this.transport.send({
+          jsonrpc: "2.0",
+          id: request.id,
+          error: {
+            code: -32601,
+            message: `Unsupported request method: ${request.method}`
+          }
+        });
+        return;
+      }
+      if (!this.elicitationRequestHandler) {
+        await this.transport.send({
+          jsonrpc: "2.0",
+          id: request.id,
+          error: {
+            code: -32601,
+            message: "No elicitation handler registered on client"
+          }
+        });
+        return;
+      }
+      const parsedRequest = ElicitationRequestSchema.safeParse({
+        method: request.method,
+        params: request.params
+      });
+      if (!parsedRequest.success) {
+        await this.transport.send({
+          jsonrpc: "2.0",
+          id: request.id,
+          error: {
+            code: -32602,
+            message: `Invalid elicitation request: ${parsedRequest.error.message}`,
+            data: parsedRequest.error.issues
+          }
+        });
+        return;
+      }
+      try {
+        const result = await this.elicitationRequestHandler(parsedRequest.data);
+        const validatedResult = ElicitResultSchema.parse(result);
+        await this.transport.send({
+          jsonrpc: "2.0",
+          id: request.id,
+          result: validatedResult
+        });
+      } catch (error) {
+        await this.transport.send({
+          jsonrpc: "2.0",
+          id: request.id,
+          error: {
+            code: -32603,
+            message: error instanceof Error ? error.message : "Failed to handle elicitation request"
+          }
+        });
+        this.onError(error);
+      }
+    } catch (error) {
+      this.onError(error);
+    }
+  }
   onClose() {
     if (this.isClosed) return;
     this.isClosed = true;
@@ -1924,6 +2026,8 @@ var DefaultMCPClient = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ElicitResultSchema,
+  ElicitationRequestSchema,
   UnauthorizedError,
   auth,
   experimental_createMCPClient