@modelcontextprotocol/ext-apps 1.1.1 → 1.1.2

package/dist/src/app.d.ts

@@ -1,7 +1,7 @@
 import { type RequestOptions, Protocol, ProtocolOptions } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { CallToolRequest, CallToolResult, Implementation, ListToolsRequest, LoggingMessageNotification } from "@modelcontextprotocol/sdk/types.js";
 import { AppNotification, AppRequest, AppResult } from "./types";
-import { McpUiAppCapabilities, McpUiUpdateModelContextRequest, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiMessageRequest, McpUiOpenLinkRequest, McpUiResourceTeardownRequest, McpUiResourceTeardownResult, McpUiSizeChangedNotification, McpUiToolCancelledNotification, McpUiToolInputNotification, McpUiToolInputPartialNotification, McpUiToolResultNotification, McpUiRequestDisplayModeRequest } from "./types";
+import { McpUiAppCapabilities, McpUiUpdateModelContextRequest, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiMessageRequest, McpUiOpenLinkRequest, McpUiDownloadFileRequest, McpUiResourceTeardownRequest, McpUiResourceTeardownResult, McpUiSizeChangedNotification, McpUiToolCancelledNotification, McpUiToolInputNotification, McpUiToolInputPartialNotification, McpUiToolResultNotification, McpUiRequestDisplayModeRequest } from "./types";
 import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
 export { PostMessageTransport } from "./message-transport";
 export * from "./types";
@@ -708,6 +708,73 @@ export declare class App extends Protocol<AppRequest, AppNotification, AppResult
     }>;
     /** @deprecated Use {@link openLink `openLink`} instead */
     sendOpenLink: App["openLink"];
+    /**
+     * Request the host to download a file.
+     *
+     * Since MCP Apps run in sandboxed iframes where direct downloads are blocked,
+     * this provides a host-mediated mechanism for file exports. The host will
+     * typically show a confirmation dialog before initiating the download.
+     *
+     * Uses standard MCP resource types: `EmbeddedResource` for inline content
+     * and `ResourceLink` for content the host can fetch directly.
+     *
+     * @param params - Resource contents to download
+     * @param options - Request options (timeout, etc.)
+     * @returns Result with `isError: true` if the host denied the request (e.g., user cancelled)
+     *
+     * @throws {Error} If the request times out or the connection is lost
+     *
+     * @example Download a JSON file (embedded text resource)
+     * ```ts
+     * const data = JSON.stringify({ items: selectedItems }, null, 2);
+     * const { isError } = await app.downloadFile({
+     *   contents: [{
+     *     type: "resource",
+     *     resource: {
+     *       uri: "file:///export.json",
+     *       mimeType: "application/json",
+     *       text: data,
+     *     },
+     *   }],
+     * });
+     * if (isError) {
+     *   console.warn("Download denied or cancelled");
+     * }
+     * ```
+     *
+     * @example Download binary content (embedded blob resource)
+     * ```ts
+     * const { isError } = await app.downloadFile({
+     *   contents: [{
+     *     type: "resource",
+     *     resource: {
+     *       uri: "file:///image.png",
+     *       mimeType: "image/png",
+     *       blob: base64EncodedPng,
+     *     },
+     *   }],
+     * });
+     * ```
+     *
+     * @example Download via resource link (host fetches)
+     * ```ts
+     * const { isError } = await app.downloadFile({
+     *   contents: [{
+     *     type: "resource_link",
+     *     uri: "https://api.example.com/reports/q4.pdf",
+     *     name: "Q4 Report",
+     *     mimeType: "application/pdf",
+     *   }],
+     * });
+     * ```
+     *
+     * @see {@link McpUiDownloadFileRequest `McpUiDownloadFileRequest`} for request structure
+     * @see {@link McpUiDownloadFileResult `McpUiDownloadFileResult`} for result structure
+     */
+    downloadFile(params: McpUiDownloadFileRequest["params"], options?: RequestOptions): Promise<{
+        [x: string]: unknown;
+        isError?: boolean | undefined;
+    }>;
     /**
      * Request a change to the display mode.
      *