@ai-sdk/mcp 2.0.0-beta.5 → 2.0.0-beta.66

package/dist/index.d.ts

@@ -77,6 +77,8 @@ declare const OAuthTokensSchema: z.ZodObject<{
     expires_in: z.ZodOptional<z.ZodNumber>;
     scope: z.ZodOptional<z.ZodString>;
     refresh_token: z.ZodOptional<z.ZodString>;
+    authorization_server: z.ZodOptional<z.ZodString>;
+    token_endpoint: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 declare const OAuthMetadataSchema: z.ZodObject<{
     issuer: z.ZodString;
@@ -116,6 +118,8 @@ declare const OAuthClientInformationSchema: z.ZodObject<{
     client_secret: z.ZodOptional<z.ZodString>;
     client_id_issued_at: z.ZodOptional<z.ZodNumber>;
     client_secret_expires_at: z.ZodOptional<z.ZodNumber>;
+    authorization_server: z.ZodOptional<z.ZodString>;
+    token_endpoint: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 declare const OAuthClientMetadataSchema: z.ZodObject<{
     redirect_uris: z.ZodArray<z.ZodString>;
@@ -143,6 +147,10 @@ type AuthorizationServerMetadata = OAuthMetadata | OpenIdProviderDiscoveryMetada
 type OAuthClientMetadata = z.infer<typeof OAuthClientMetadataSchema>;
 
 type AuthResult = 'AUTHORIZED' | 'REDIRECT';
+interface OAuthAuthorizationServerInformation {
+    authorizationServerUrl: string;
+    tokenEndpoint: string;
+}
 interface OAuthClientProvider {
     /**
      * Returns current access token if present; undefined otherwise.
@@ -181,6 +189,13 @@ interface OAuthClientProvider {
     get clientMetadata(): OAuthClientMetadata;
     clientInformation(): OAuthClientInformation | undefined | Promise<OAuthClientInformation | undefined>;
     saveClientInformation?(clientInformation: OAuthClientInformation): void | Promise<void>;
+    authorizationServerInformation?(): OAuthAuthorizationServerInformation | undefined | Promise<OAuthAuthorizationServerInformation | undefined>;
+    saveAuthorizationServerInformation?(authorizationServerInformation: OAuthAuthorizationServerInformation): void | Promise<void>;
+    /**
+     * Validates an authorization server URL discovered from MCP protected resource
+     * metadata before the client fetches its OAuth metadata.
+     */
+    validateAuthorizationServerURL?(serverUrl: string | URL, authorizationServerUrl: string | URL): void | Promise<void>;
     state?(): string | Promise<string>;
     saveState?(state: string): void | Promise<void>;
     storedState?(): string | undefined | Promise<string | undefined>;
@@ -228,6 +243,14 @@ interface MCPTransport {
      * Event handler for received messages
      */
     onmessage?: (message: JSONRPCMessage) => void;
+    /**
+     * The protocol version negotiated during initialization.
+     */
+    protocolVersion?: string;
+    /**
+     * Set the protocol version negotiated during initialization.
+     */
+    setProtocolVersion?(version: string): void;
 }
 type MCPTransportConfig = {
     type: 'sse' | 'http';
@@ -243,8 +266,27 @@ type MCPTransportConfig = {
      * An optional OAuth client provider to use for authentication for MCP servers.
      */
     authProvider?: OAuthClientProvider;
+    /**
+     * Controls how HTTP redirects are handled for transport requests.
+     * - `'follow'`: Follow redirects automatically (standard fetch behavior).
+     * - `'error'`: Reject any redirect response with an error.
+     * @default 'error'
+     */
+    redirect?: 'follow' | 'error';
+    /**
+     * Optional custom fetch implementation to use for HTTP requests.
+     * Useful for runtimes that need a request-local fetch.
+     * @default globalThis.fetch
+     */
+    fetch?: FetchFunction;
 };
 
+type McpProviderMetadata = {
+    clientName?: string;
+    title?: string;
+    toolName?: string;
+    app?: JSONObject;
+};
 /** 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>;
@@ -267,6 +309,12 @@ type McpToolSet<TOOL_SCHEMAS extends ToolSchemas = 'automatic'> = TOOL_SCHEMAS e
         inputSchema: FlexibleSchema<infer INPUT>;
     } ? McpToolBase<INPUT, CallToolResult> : never;
 } : Record<string, McpToolBase<unknown, CallToolResult>>;
+declare const ClientOrServerImplementationSchema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+type Configuration = z.infer<typeof ClientOrServerImplementationSchema>;
 declare const BaseParamsSchema: z.ZodObject<{
     _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
 }, z.core.$loose>;
@@ -350,6 +398,12 @@ declare const CallToolResultSchema: z.ZodUnion<[z.ZodObject<{
             mimeType: z.ZodOptional<z.ZodString>;
             blob: z.ZodBase64;
         }, z.core.$loose>]>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"resource_link">;
+        uri: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        mimeType: z.ZodOptional<z.ZodString>;
     }, z.core.$loose>]>>;
     structuredContent: z.ZodOptional<z.ZodUnknown>;
     isError: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
@@ -428,6 +482,12 @@ declare const GetPromptResultSchema: z.ZodObject<{
                 mimeType: z.ZodOptional<z.ZodString>;
                 blob: z.ZodBase64;
             }, z.core.$loose>]>;
+        }, z.core.$loose>, z.ZodObject<{
+            type: z.ZodLiteral<"resource_link">;
+            uri: z.ZodString;
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            mimeType: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>]>;
     }, z.core.$loose>>;
 }, z.core.$loose>;
@@ -454,6 +514,12 @@ interface MCPClientConfig {
     /** Optional callback for uncaught errors */
     onUncaughtError?: (error: unknown) => void;
     /** Optional client name, defaults to 'ai-sdk-mcp-client' */
+    clientName?: string;
+    /**
+     * Optional client name, defaults to 'ai-sdk-mcp-client'
+     *
+     * @deprecated Use `clientName` instead.
+     */
     name?: string;
     /** Optional client version, defaults to '1.0.0' */
     version?: string;
@@ -466,6 +532,20 @@ interface MCPClientConfig {
 }
 declare function createMCPClient(config: MCPClientConfig): Promise<MCPClient>;
 interface MCPClient {
+    /**
+     * Information about the connected MCP server, as reported during initialization.
+     * @see https://modelcontextprotocol.io/specification/2025-11-25/schema#implementation
+     */
+    readonly serverInfo: Configuration;
+    /**
+     * Optional instructions provided by the server during the initialize handshake.
+     *
+     * These describe how to use the server and its features, and can be used by clients
+     * to improve LLM interactions (e.g. by including them in the system prompt).
+     *
+     * @see https://modelcontextprotocol.io/specification/2025-11-25/schema#initializeresult
+     */
+    readonly instructions?: string;
     tools<TOOL_SCHEMAS extends ToolSchemas = 'automatic'>(options?: {
         schemas?: TOOL_SCHEMAS;
     }): Promise<McpToolSet<TOOL_SCHEMAS>>;
@@ -476,6 +556,14 @@ interface MCPClient {
         params?: PaginatedRequest['params'];
         options?: RequestOptions;
     }): Promise<ListToolsResult>;
+    /**
+     * Calls a tool on the MCP server.
+     */
+    callTool(args: {
+        name: string;
+        arguments?: Record<string, unknown>;
+        options?: RequestOptions;
+    }): Promise<CallToolResult>;
     /**
      * Creates AI SDK tools from tool definitions.
      */
@@ -506,4 +594,61 @@ interface MCPClient {
     close: () => Promise<void>;
 }
 
-export { 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 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 };
+/**
+ * MIME type for HTML resources that are meant to be rendered as MCP Apps.
+ */
+declare const MCP_APP_MIME_TYPE: "text/html;profile=mcp-app";
+/**
+ * Client capabilities to pass to `createMCPClient` when the host supports MCP Apps.
+ */
+declare const mcpAppClientCapabilities: {
+    readonly extensions: {
+        readonly "io.modelcontextprotocol/ui": {
+            readonly mimeTypes: readonly ["text/html;profile=mcp-app"];
+        };
+    };
+};
+/**
+ * Content security policy metadata requested by an MCP App resource.
+ */
+type MCPAppResourceCSP = {
+    connectDomains?: string[];
+    resourceDomains?: string[];
+    frameDomains?: string[];
+    [key: string]: unknown;
+};
+/**
+ * Host rendering metadata from an MCP App resource.
+ */
+type MCPAppResourceMeta = {
+    prefersBorder?: boolean;
+    csp?: MCPAppResourceCSP;
+    permissions?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/**
+ * HTML and metadata needed by a host to render an MCP App.
+ */
+type MCPAppResource = {
+    uri: string;
+    mimeType: typeof MCP_APP_MIME_TYPE;
+    html: string;
+    meta?: MCPAppResourceMeta;
+};
+/**
+ * Splits tool definitions into model-visible tools and app-visible tools.
+ */
+declare function splitMCPAppTools(definitions: ListToolsResult): {
+    modelVisible: ListToolsResult;
+    appVisible: ListToolsResult;
+};
+/**
+ * Reads a `ui://` resource from an MCP server and normalizes it for rendering.
+ */
+declare function readMCPAppResource({ client, uri, options, }: {
+    client: Pick<MCPClient, 'readResource'>;
+    uri: string;
+    options?: RequestOptions;
+}): Promise<MCPAppResource>;
+
+export { type CallToolResult, type Configuration, type ElicitResult, ElicitResultSchema, type ElicitationRequest, ElicitationRequestSchema, type JSONRPCError, type JSONRPCMessage, type JSONRPCNotification, type JSONRPCRequest, type JSONRPCResponse, type ListToolsResult, type MCPAppResource, type MCPAppResourceCSP, type MCPAppResourceMeta, type MCPClient, type ClientCapabilities as MCPClientCapabilities, type MCPClientConfig, type MCPTransport, MCP_APP_MIME_TYPE, type McpProviderMetadata, 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, mcpAppClientCapabilities, readMCPAppResource, splitMCPAppTools };