@ai-sdk/mcp 2.0.0-canary.42 → 2.0.0-canary.44

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/mcp
 
+## 2.0.0-canary.44
+
+### Patch Changes
+
+- 611f621: feat(mcp): feat(mcp): add support for MCP Apps
+
+## 2.0.0-canary.43
+
+### Patch Changes
+
+- f634bac: feat(mcp): add new McpProviderMetadata type
+- Updated dependencies [f634bac]
+  - @ai-sdk/provider-utils@5.0.0-canary.35
+
 ## 2.0.0-canary.42
 
 ### Patch Changes

package/dist/index.d.ts

@@ -258,6 +258,12 @@ type MCPTransportConfig = {
     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>;
@@ -527,6 +533,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.
      */
@@ -557,4 +571,61 @@ interface MCPClient {
     close: () => Promise<void>;
 }
 
-export { 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 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 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 };

package/dist/index.js

@@ -1618,6 +1618,112 @@ function isCustomMcpTransport(transport) {
   return "start" in transport && typeof transport.start === "function" && "send" in transport && typeof transport.send === "function" && "close" in transport && typeof transport.close === "function";
 }
 
+// src/tool/mcp-apps.ts
+import { isJSONObject } from "@ai-sdk/provider";
+import { convertBase64ToUint8Array } from "@ai-sdk/provider-utils";
+var MCP_APP_EXTENSION_NAME = "io.modelcontextprotocol/ui";
+var MCP_APP_MIME_TYPE = "text/html;profile=mcp-app";
+var MCP_APP_LEGACY_RESOURCE_URI_META_KEY = "ui/resourceUri";
+var mcpAppClientCapabilities = {
+  extensions: {
+    [MCP_APP_EXTENSION_NAME]: {
+      mimeTypes: [MCP_APP_MIME_TYPE]
+    }
+  }
+};
+function getToolUiMeta(meta) {
+  const uiMeta = meta == null ? void 0 : meta.ui;
+  return isJSONObject(uiMeta) ? uiMeta : void 0;
+}
+function getResourceUiMeta(meta) {
+  const resourceMeta = isJSONObject(meta) ? meta : void 0;
+  const rawUiMeta = resourceMeta == null ? void 0 : resourceMeta.ui;
+  const uiMeta = isJSONObject(rawUiMeta) ? rawUiMeta : void 0;
+  return uiMeta;
+}
+function parseVisibility(value) {
+  return Array.isArray(value) ? value.filter(
+    (v) => v === "model" || v === "app"
+  ) : void 0;
+}
+function getMCPAppToolMeta(tool2) {
+  var _a3, _b3;
+  const uiMeta = getToolUiMeta(tool2._meta);
+  const resourceUri = (_b3 = uiMeta == null ? void 0 : uiMeta.resourceUri) != null ? _b3 : (_a3 = tool2._meta) == null ? void 0 : _a3[MCP_APP_LEGACY_RESOURCE_URI_META_KEY];
+  const visibility = parseVisibility(uiMeta == null ? void 0 : uiMeta.visibility);
+  if (resourceUri !== void 0) {
+    if (typeof resourceUri !== "string" || !resourceUri.startsWith("ui://")) {
+      throw new Error(
+        `Invalid MCP App resource URI: ${JSON.stringify(resourceUri)}`
+      );
+    }
+  } else if (uiMeta == null) {
+    return void 0;
+  }
+  return {
+    ...uiMeta,
+    ...resourceUri != null ? { resourceUri } : {},
+    ...visibility != null ? { visibility } : {}
+  };
+}
+function splitMCPAppTools(definitions) {
+  var _a3;
+  const modelVisibleTools = [];
+  const appVisibleTools = [];
+  for (const tool2 of definitions.tools) {
+    const visibility = (_a3 = getMCPAppToolMeta(tool2)) == null ? void 0 : _a3.visibility;
+    if (visibility == null || visibility.includes("model")) {
+      modelVisibleTools.push(tool2);
+    }
+    if ((visibility == null ? void 0 : visibility.includes("app")) === true) {
+      appVisibleTools.push(tool2);
+    }
+  }
+  return {
+    modelVisible: {
+      ...definitions,
+      tools: modelVisibleTools
+    },
+    appVisible: {
+      ...definitions,
+      tools: appVisibleTools
+    }
+  };
+}
+function getMCPAppResourceFromReadResult({
+  uri,
+  resource
+}) {
+  const content = resource.contents.find((content2) => content2.uri === uri);
+  if (content == null) {
+    throw new Error(`MCP App resource not found in read result: ${uri}`);
+  }
+  if (content.mimeType !== MCP_APP_MIME_TYPE) {
+    throw new Error(
+      `Unsupported MCP App resource MIME type: ${content.mimeType}`
+    );
+  }
+  const html = "text" in content && typeof content.text === "string" ? content.text : "blob" in content && typeof content.blob === "string" ? new TextDecoder().decode(convertBase64ToUint8Array(content.blob)) : void 0;
+  if (html == null) {
+    throw new Error(`Unsupported MCP App resource content format: ${uri}`);
+  }
+  const meta = getResourceUiMeta(content._meta);
+  return { uri, mimeType: MCP_APP_MIME_TYPE, html, meta };
+}
+async function readMCPAppResource({
+  client,
+  uri,
+  options
+}) {
+  if (!uri.startsWith("ui://")) {
+    throw new Error(`Unsupported MCP App resource URI: ${uri}`);
+  }
+  return getMCPAppResourceFromReadResult({
+    uri,
+    resource: await client.readResource({ uri, options })
+  });
+}
+
 // src/tool/mcp-client.ts
 var CLIENT_VERSION = "1.0.0";
 function mcpToModelOutput({
@@ -1842,16 +1948,14 @@ var DefaultMCPClient = class {
   }
   async callTool({
     name: name3,
-    args,
+    arguments: args = {},
     options
   }) {
     try {
       return this.request({
         request: { method: "tools/call", params: { name: name3, arguments: args } },
         resultSchema: CallToolResultSchema,
-        options: {
-          signal: options == null ? void 0 : options.abortSignal
-        }
+        options
       });
     } catch (error) {
       throw error;
@@ -1967,10 +2071,26 @@ var DefaultMCPClient = class {
       }
       const self = this;
       const outputSchema = schemas !== "automatic" ? (_a3 = schemas[name3]) == null ? void 0 : _a3.outputSchema : void 0;
+      const appMeta = getMCPAppToolMeta({ _meta });
+      const metadata = {
+        clientName: this.clientInfo.name,
+        toolName: name3,
+        ...resolvedTitle != null ? { title: resolvedTitle } : {},
+        ...(appMeta == null ? void 0 : appMeta.resourceUri) != null ? {
+          app: {
+            ...appMeta,
+            mimeType: MCP_APP_MIME_TYPE
+          }
+        } : {}
+      };
       const execute = async (args, options) => {
         var _a4;
         (_a4 = options == null ? void 0 : options.abortSignal) == null ? void 0 : _a4.throwIfAborted();
-        const result = await self.callTool({ name: name3, args, options });
+        const result = await self.callTool({
+          name: name3,
+          arguments: args,
+          options: { signal: options == null ? void 0 : options.abortSignal }
+        });
         if (result.isError) {
           return result;
         }
@@ -1982,9 +2102,7 @@ var DefaultMCPClient = class {
       const toolWithExecute = schemas === "automatic" ? dynamicTool({
         description,
         title: resolvedTitle,
-        metadata: {
-          clientName: this.clientInfo.name
-        },
+        metadata,
         inputSchema: jsonSchema({
           ...inputSchema,
           properties: (_b3 = inputSchema.properties) != null ? _b3 : {},
@@ -1995,9 +2113,7 @@ var DefaultMCPClient = class {
       }) : tool({
         description,
         title: resolvedTitle,
-        metadata: {
-          clientName: this.clientInfo.name
-        },
+        metadata,
         inputSchema: schemas[name3].inputSchema,
         ...outputSchema != null ? { outputSchema } : {},
         execute,
@@ -2185,9 +2301,13 @@ var DefaultMCPClient = class {
 export {
   ElicitResultSchema,
   ElicitationRequestSchema,
+  MCP_APP_MIME_TYPE,
   UnauthorizedError,
   auth,
   createMCPClient,
-  createMCPClient as experimental_createMCPClient
+  createMCPClient as experimental_createMCPClient,
+  mcpAppClientCapabilities,
+  readMCPAppResource,
+  splitMCPAppTools
 };
 //# sourceMappingURL=index.js.map