@ai-sdk/mcp 1.0.0-beta.4 → 1.0.0-beta.40

package/CHANGELOG.md

@@ -1,5 +1,270 @@
 # @ai-sdk/mcp
 
+## 1.0.0-beta.40
+
+### Patch Changes
+
+- 90ede04: feat(mcp): make MCPClient stable
+
+## 1.0.0-beta.39
+
+### Patch Changes
+
+- Updated dependencies [366f50b]
+  - @ai-sdk/provider@3.0.0-beta.27
+  - @ai-sdk/provider-utils@4.0.0-beta.53
+
+## 1.0.0-beta.38
+
+### Patch Changes
+
+- Updated dependencies [763d04a]
+  - @ai-sdk/provider-utils@4.0.0-beta.52
+
+## 1.0.0-beta.37
+
+### Patch Changes
+
+- Updated dependencies [c1efac4]
+  - @ai-sdk/provider-utils@4.0.0-beta.51
+
+## 1.0.0-beta.36
+
+### Patch Changes
+
+- Updated dependencies [32223c8]
+  - @ai-sdk/provider-utils@4.0.0-beta.50
+
+## 1.0.0-beta.35
+
+### Patch Changes
+
+- Updated dependencies [83e5744]
+  - @ai-sdk/provider-utils@4.0.0-beta.49
+
+## 1.0.0-beta.34
+
+### Patch Changes
+
+- Updated dependencies [960ec8f]
+  - @ai-sdk/provider-utils@4.0.0-beta.48
+
+## 1.0.0-beta.33
+
+### Patch Changes
+
+- Updated dependencies [e9e157f]
+  - @ai-sdk/provider-utils@4.0.0-beta.47
+
+## 1.0.0-beta.32
+
+### Patch Changes
+
+- Updated dependencies [81e29ab]
+  - @ai-sdk/provider-utils@4.0.0-beta.46
+
+## 1.0.0-beta.31
+
+### Patch Changes
+
+- Updated dependencies [3bd2689]
+  - @ai-sdk/provider@3.0.0-beta.26
+  - @ai-sdk/provider-utils@4.0.0-beta.45
+
+## 1.0.0-beta.30
+
+### Patch Changes
+
+- 6f1577e: fix(mcp): pass json header for refreshAuth
+
+## 1.0.0-beta.29
+
+### Patch Changes
+
+- Updated dependencies [53f3368]
+  - @ai-sdk/provider@3.0.0-beta.25
+  - @ai-sdk/provider-utils@4.0.0-beta.44
+
+## 1.0.0-beta.28
+
+### Patch Changes
+
+- Updated dependencies [dce03c4]
+  - @ai-sdk/provider-utils@4.0.0-beta.43
+  - @ai-sdk/provider@3.0.0-beta.24
+
+## 1.0.0-beta.27
+
+### Patch Changes
+
+- 3ed5519: chore: rename ToolCallOptions to ToolExecutionOptions
+- Updated dependencies [3ed5519]
+  - @ai-sdk/provider-utils@4.0.0-beta.42
+
+## 1.0.0-beta.26
+
+### Patch Changes
+
+- 17c04d4: feat(mcp): expose `_meta` field from MCP tool definitions
+
+## 1.0.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [1bd7d32]
+  - @ai-sdk/provider-utils@4.0.0-beta.41
+  - @ai-sdk/provider@3.0.0-beta.23
+
+## 1.0.0-beta.24
+
+### Patch Changes
+
+- Updated dependencies [544d4e8]
+  - @ai-sdk/provider-utils@4.0.0-beta.40
+  - @ai-sdk/provider@3.0.0-beta.22
+
+## 1.0.0-beta.23
+
+### Patch Changes
+
+- Updated dependencies [954c356]
+  - @ai-sdk/provider-utils@4.0.0-beta.39
+  - @ai-sdk/provider@3.0.0-beta.21
+
+## 1.0.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [03849b0]
+  - @ai-sdk/provider-utils@4.0.0-beta.38
+
+## 1.0.0-beta.21
+
+### Patch Changes
+
+- Updated dependencies [457318b]
+  - @ai-sdk/provider@3.0.0-beta.20
+  - @ai-sdk/provider-utils@4.0.0-beta.37
+
+## 1.0.0-beta.20
+
+### Patch Changes
+
+- Updated dependencies [8d9e8ad]
+  - @ai-sdk/provider@3.0.0-beta.19
+  - @ai-sdk/provider-utils@4.0.0-beta.36
+
+## 1.0.0-beta.19
+
+### Patch Changes
+
+- Updated dependencies [10d819b]
+  - @ai-sdk/provider@3.0.0-beta.18
+  - @ai-sdk/provider-utils@4.0.0-beta.35
+
+## 1.0.0-beta.18
+
+### Patch Changes
+
+- ba2ca2d: feat(mcp): add the possibility to define client version in mcp client definition
+
+## 1.0.0-beta.17
+
+### Patch Changes
+
+- f702df2: feat(mcp): add client elicitation support
+
+## 1.0.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [db913bd]
+  - @ai-sdk/provider@3.0.0-beta.17
+  - @ai-sdk/provider-utils@4.0.0-beta.34
+
+## 1.0.0-beta.15
+
+### Patch Changes
+
+- Updated dependencies [b681d7d]
+  - @ai-sdk/provider@3.0.0-beta.16
+  - @ai-sdk/provider-utils@4.0.0-beta.33
+
+## 1.0.0-beta.14
+
+### Patch Changes
+
+- Updated dependencies [32d8dbb]
+  - @ai-sdk/provider-utils@4.0.0-beta.32
+
+## 1.0.0-beta.13
+
+### Patch Changes
+
+- 1cff766: feat(packages/mcp): add support for MCP server prompts exposed
+
+## 1.0.0-beta.12
+
+### Patch Changes
+
+- Updated dependencies [bb36798]
+  - @ai-sdk/provider@3.0.0-beta.15
+  - @ai-sdk/provider-utils@4.0.0-beta.31
+
+## 1.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [4f16c37]
+  - @ai-sdk/provider-utils@4.0.0-beta.30
+
+## 1.0.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [af3780b]
+  - @ai-sdk/provider@3.0.0-beta.14
+  - @ai-sdk/provider-utils@4.0.0-beta.29
+
+## 1.0.0-beta.9
+
+### Patch Changes
+
+- Updated dependencies [016b111]
+  - @ai-sdk/provider-utils@4.0.0-beta.28
+
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- Updated dependencies [37c58a0]
+  - @ai-sdk/provider@3.0.0-beta.13
+  - @ai-sdk/provider-utils@4.0.0-beta.27
+
+## 1.0.0-beta.7
+
+### Patch Changes
+
+- Updated dependencies [d1bdadb]
+  - @ai-sdk/provider@3.0.0-beta.12
+  - @ai-sdk/provider-utils@4.0.0-beta.26
+
+## 1.0.0-beta.6
+
+### Patch Changes
+
+- Updated dependencies [4c44a5b]
+  - @ai-sdk/provider@3.0.0-beta.11
+  - @ai-sdk/provider-utils@4.0.0-beta.25
+
+## 1.0.0-beta.5
+
+### Patch Changes
+
+- Updated dependencies [0c3b58b]
+  - @ai-sdk/provider@3.0.0-beta.10
+  - @ai-sdk/provider-utils@4.0.0-beta.24
+
 ## 1.0.0-beta.4
 
 ### Patch Changes

package/dist/index.d.mts

@@ -242,18 +242,23 @@ type MCPTransportConfig = {
     authProvider?: OAuthClientProvider;
 };
 
+/** MCP tool metadata - keys should follow MCP _meta key format specification */
+declare const ToolMetaSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+type ToolMeta = z.infer<typeof ToolMetaSchema>;
 type ToolSchemas = Record<string, {
     inputSchema: FlexibleSchema<JSONObject | unknown>;
 }> | 'automatic' | undefined;
+/** Base MCP tool type with execute and _meta */
+type McpToolBase<INPUT = unknown> = Tool<INPUT, CallToolResult> & Required<Pick<Tool<INPUT, CallToolResult>, 'execute'>> & {
+    _meta?: ToolMeta;
+};
 type McpToolSet<TOOL_SCHEMAS extends ToolSchemas = 'automatic'> = TOOL_SCHEMAS extends Record<string, {
     inputSchema: FlexibleSchema<any>;
 }> ? {
     [K in keyof TOOL_SCHEMAS]: TOOL_SCHEMAS[K] extends {
         inputSchema: FlexibleSchema<infer INPUT>;
-    } ? Tool<INPUT, CallToolResult> & Required<Pick<Tool<INPUT, CallToolResult>, 'execute'>> : never;
-} : McpToolSet<Record<string, {
-    inputSchema: FlexibleSchema<unknown>;
-}>>;
+    } ? McpToolBase<INPUT> : never;
+} : Record<string, McpToolBase<unknown>>;
 declare const BaseParamsSchema: z.ZodObject<{
     _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
 }, z.core.$loose>;
@@ -270,6 +275,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;
@@ -347,6 +358,67 @@ declare const ReadResourceResultSchema: z.ZodObject<{
     }, z.core.$loose>]>>;
 }, z.core.$loose>;
 type ReadResourceResult = z.infer<typeof ReadResourceResultSchema>;
+declare const ListPromptsResultSchema: z.ZodObject<{
+    _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    nextCursor: z.ZodOptional<z.ZodString>;
+    prompts: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        arguments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            required: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$loose>>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+type ListPromptsResult = z.infer<typeof ListPromptsResultSchema>;
+declare const GetPromptResultSchema: z.ZodObject<{
+    _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    description: z.ZodOptional<z.ZodString>;
+    messages: z.ZodArray<z.ZodObject<{
+        role: z.ZodUnion<readonly [z.ZodLiteral<"user">, z.ZodLiteral<"assistant">]>;
+        content: z.ZodUnion<readonly [z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            text: z.ZodString;
+        }, z.core.$loose>, z.ZodObject<{
+            type: z.ZodLiteral<"image">;
+            data: z.ZodBase64;
+            mimeType: z.ZodString;
+        }, z.core.$loose>, z.ZodObject<{
+            type: z.ZodLiteral<"resource">;
+            resource: z.ZodUnion<readonly [z.ZodObject<{
+                uri: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+                mimeType: z.ZodOptional<z.ZodString>;
+                text: z.ZodString;
+            }, z.core.$loose>, z.ZodObject<{
+                uri: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+                mimeType: z.ZodOptional<z.ZodString>;
+                blob: z.ZodBase64;
+            }, z.core.$loose>]>;
+        }, z.core.$loose>]>;
+    }, 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 */
@@ -355,6 +427,14 @@ interface MCPClientConfig {
     onUncaughtError?: (error: unknown) => void;
     /** Optional client name, defaults to 'ai-sdk-mcp-client' */
     name?: string;
+    /** Optional client version, defaults to '1.0.0' */
+    version?: 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 {
@@ -372,7 +452,17 @@ interface MCPClient {
     listResourceTemplates(options?: {
         options?: RequestOptions;
     }): Promise<ListResourceTemplatesResult>;
+    experimental_listPrompts(options?: {
+        params?: PaginatedRequest['params'];
+        options?: RequestOptions;
+    }): Promise<ListPromptsResult>;
+    experimental_getPrompt(args: {
+        name: string;
+        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 MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, 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 };

package/dist/index.d.ts

@@ -242,18 +242,23 @@ type MCPTransportConfig = {
     authProvider?: OAuthClientProvider;
 };
 
+/** MCP tool metadata - keys should follow MCP _meta key format specification */
+declare const ToolMetaSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+type ToolMeta = z.infer<typeof ToolMetaSchema>;
 type ToolSchemas = Record<string, {
     inputSchema: FlexibleSchema<JSONObject | unknown>;
 }> | 'automatic' | undefined;
+/** Base MCP tool type with execute and _meta */
+type McpToolBase<INPUT = unknown> = Tool<INPUT, CallToolResult> & Required<Pick<Tool<INPUT, CallToolResult>, 'execute'>> & {
+    _meta?: ToolMeta;
+};
 type McpToolSet<TOOL_SCHEMAS extends ToolSchemas = 'automatic'> = TOOL_SCHEMAS extends Record<string, {
     inputSchema: FlexibleSchema<any>;
 }> ? {
     [K in keyof TOOL_SCHEMAS]: TOOL_SCHEMAS[K] extends {
         inputSchema: FlexibleSchema<infer INPUT>;
-    } ? Tool<INPUT, CallToolResult> & Required<Pick<Tool<INPUT, CallToolResult>, 'execute'>> : never;
-} : McpToolSet<Record<string, {
-    inputSchema: FlexibleSchema<unknown>;
-}>>;
+    } ? McpToolBase<INPUT> : never;
+} : Record<string, McpToolBase<unknown>>;
 declare const BaseParamsSchema: z.ZodObject<{
     _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
 }, z.core.$loose>;
@@ -270,6 +275,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;
@@ -347,6 +358,67 @@ declare const ReadResourceResultSchema: z.ZodObject<{
     }, z.core.$loose>]>>;
 }, z.core.$loose>;
 type ReadResourceResult = z.infer<typeof ReadResourceResultSchema>;
+declare const ListPromptsResultSchema: z.ZodObject<{
+    _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    nextCursor: z.ZodOptional<z.ZodString>;
+    prompts: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        arguments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            required: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$loose>>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+type ListPromptsResult = z.infer<typeof ListPromptsResultSchema>;
+declare const GetPromptResultSchema: z.ZodObject<{
+    _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
+    description: z.ZodOptional<z.ZodString>;
+    messages: z.ZodArray<z.ZodObject<{
+        role: z.ZodUnion<readonly [z.ZodLiteral<"user">, z.ZodLiteral<"assistant">]>;
+        content: z.ZodUnion<readonly [z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            text: z.ZodString;
+        }, z.core.$loose>, z.ZodObject<{
+            type: z.ZodLiteral<"image">;
+            data: z.ZodBase64;
+            mimeType: z.ZodString;
+        }, z.core.$loose>, z.ZodObject<{
+            type: z.ZodLiteral<"resource">;
+            resource: z.ZodUnion<readonly [z.ZodObject<{
+                uri: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+                mimeType: z.ZodOptional<z.ZodString>;
+                text: z.ZodString;
+            }, z.core.$loose>, z.ZodObject<{
+                uri: z.ZodString;
+                name: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+                mimeType: z.ZodOptional<z.ZodString>;
+                blob: z.ZodBase64;
+            }, z.core.$loose>]>;
+        }, z.core.$loose>]>;
+    }, 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 */
@@ -355,6 +427,14 @@ interface MCPClientConfig {
     onUncaughtError?: (error: unknown) => void;
     /** Optional client name, defaults to 'ai-sdk-mcp-client' */
     name?: string;
+    /** Optional client version, defaults to '1.0.0' */
+    version?: 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 {
@@ -372,7 +452,17 @@ interface MCPClient {
     listResourceTemplates(options?: {
         options?: RequestOptions;
     }): Promise<ListResourceTemplatesResult>;
+    experimental_listPrompts(options?: {
+        params?: PaginatedRequest['params'];
+        options?: RequestOptions;
+    }): Promise<ListPromptsResult>;
+    experimental_getPrompt(args: {
+        name: string;
+        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 MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, 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 };