@modelcontextprotocol/ext-apps 0.3.1 → 0.4.1

package/dist/src/app-bridge.d.ts

@@ -1,8 +1,8 @@
 import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
-import { CallToolRequest, CallToolResult, Implementation, ListPromptsRequest, ListPromptsResult, ListResourcesRequest, ListResourcesResult, ListResourceTemplatesRequest, ListResourceTemplatesResult, LoggingMessageNotification, PingRequest, PromptListChangedNotification, ReadResourceRequest, ReadResourceResult, ResourceListChangedNotification, ToolListChangedNotification } from "@modelcontextprotocol/sdk/types.js";
+import { CallToolRequest, CallToolResult, EmptyResult, Implementation, ListPromptsRequest, ListPromptsResult, ListResourcesRequest, ListResourcesResult, ListResourceTemplatesRequest, ListResourceTemplatesResult, LoggingMessageNotification, PingRequest, PromptListChangedNotification, ReadResourceRequest, ReadResourceResult, ResourceListChangedNotification, Tool, ToolListChangedNotification } from "@modelcontextprotocol/sdk/types.js";
 import { Protocol, ProtocolOptions, RequestOptions } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { type AppNotification, type AppRequest, type AppResult, type McpUiSandboxResourceReadyNotification, type McpUiSizeChangedNotification, type McpUiToolCancelledNotification, type McpUiToolInputNotification, type McpUiToolInputPartialNotification, type McpUiToolResultNotification, McpUiAppCapabilities, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiInitializedNotification, McpUiMessageRequest, McpUiMessageResult, McpUiOpenLinkRequest, McpUiOpenLinkResult, McpUiResourceTeardownRequest, McpUiSandboxProxyReadyNotification, McpUiRequestDisplayModeRequest, McpUiRequestDisplayModeResult } from "./types";
+import { type AppNotification, type AppRequest, type AppResult, type McpUiSandboxResourceReadyNotification, type McpUiSizeChangedNotification, type McpUiToolCancelledNotification, type McpUiToolInputNotification, type McpUiToolInputPartialNotification, type McpUiToolResultNotification, McpUiAppCapabilities, McpUiUpdateModelContextRequest, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiInitializedNotification, McpUiMessageRequest, McpUiMessageResult, McpUiOpenLinkRequest, McpUiOpenLinkResult, McpUiResourceTeardownRequest, McpUiSandboxProxyReadyNotification, McpUiRequestDisplayModeRequest, McpUiRequestDisplayModeResult, McpUiResourcePermissions } from "./types";
 export * from "./types";
 export { RESOURCE_URI_META_KEY, RESOURCE_MIME_TYPE } from "./app";
 export { PostMessageTransport } from "./message-transport";
@@ -15,7 +15,7 @@ export { PostMessageTransport } from "./message-transport";
  *
  * @param tool - A tool object with optional `_meta` property
  * @returns The UI resource URI if valid, undefined if not present
- * @throws Error if resourceUri is present but invalid (not starting with "ui://")
+ * @throws Error if resourceUri is present but invalid (does not start with "ui://")
  *
  * @example
  * ```typescript
@@ -30,13 +30,31 @@ export { PostMessageTransport } from "./message-transport";
  * });
  * ```
  */
-export declare function getToolUiResourceUri(tool: {
-    _meta?: Record<string, unknown>;
-}): string | undefined;
+export declare function getToolUiResourceUri(tool: Partial<Tool>): string | undefined;
 /**
- * Options for configuring AppBridge behavior.
+ * Build iframe `allow` attribute string from permissions.
  *
- * @see ProtocolOptions from @modelcontextprotocol/sdk for available options
+ * Maps McpUiResourcePermissions to the Permission Policy allow attribute
+ * format used by iframes (e.g., "microphone; clipboard-write").
+ *
+ * @param permissions - Permissions requested by the UI resource
+ * @returns Space-separated permission directives, or empty string if none
+ *
+ * @example
+ * ```typescript
+ * const allow = buildAllowAttribute({ microphone: {}, clipboardWrite: {} });
+ * // Returns: "microphone; clipboard-write"
+ * iframe.setAttribute("allow", allow);
+ * ```
+ */
+export declare function buildAllowAttribute(permissions: McpUiResourcePermissions | undefined): string;
+/**
+ * Options for configuring {@link AppBridge} behavior.
+ *
+ * @property hostContext - Optional initial host context to provide to the Guest UI
+ *
+ * @see `ProtocolOptions` from @modelcontextprotocol/sdk for available options
+ * @see {@link McpUiHostContext} for the hostContext structure
  */
 export type HostOptions = ProtocolOptions & {
     hostContext?: McpUiHostContext;
@@ -51,7 +69,7 @@ export declare const SUPPORTED_PROTOCOL_VERSIONS: string[];
 /**
  * Extra metadata passed to request handlers.
  *
- * This type represents the additional context provided by the Protocol class
+ * This type represents the additional context provided by the `Protocol` class
  * when handling requests, including abort signals and session information.
  * It is extracted from the MCP SDK's request handler signature.
  *
@@ -59,12 +77,13 @@ export declare const SUPPORTED_PROTOCOL_VERSIONS: string[];
  */
 type RequestHandlerExtra = Parameters<Parameters<AppBridge["setRequestHandler"]>[1]>[1];
 /**
- * Host-side bridge for communicating with a single Guest UI (App).
+ * Host-side bridge for communicating with a single Guest UI ({@link app!App}).
  *
- * AppBridge extends the MCP SDK's Protocol class and acts as a proxy between
- * the host application and a Guest UI running in an iframe. It automatically
- * forwards MCP server capabilities (tools, resources, prompts) to the Guest UI
- * and handles the initialization handshake.
+ * `AppBridge` extends the MCP SDK's `Protocol` class and acts as a proxy between
+ * the host application and a Guest UI running in an iframe. When an MCP client
+ * is provided to the constructor, it automatically forwards MCP server capabilities
+ * (tools, resources, prompts) to the Guest UI. It also handles the initialization
+ * handshake.
  *
  * ## Architecture
  *
@@ -76,11 +95,11 @@ type RequestHandlerExtra = Parameters<Parameters<AppBridge["setRequestHandler"]>
  *
  * ## Lifecycle
  *
- * 1. **Create**: Instantiate AppBridge with MCP client and capabilities
+ * 1. **Create**: Instantiate `AppBridge` with MCP client and capabilities
  * 2. **Connect**: Call `connect()` with transport to establish communication
  * 3. **Wait for init**: Guest UI sends initialize request, bridge responds
- * 4. **Send data**: Call `sendToolInput()`, `sendToolResult()`, etc.
- * 5. **Teardown**: Call `teardownResource()` before unmounting iframe
+ * 4. **Send data**: Call {@link sendToolInput}, {@link sendToolResult}, etc.
+ * 5. **Teardown**: Call {@link teardownResource} before unmounting iframe
  *
  * @example Basic usage
  * ```typescript
@@ -130,7 +149,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * @param _client - MCP client connected to the server, or `null`. When provided,
      *   {@link connect} will automatically set up forwarding of MCP requests/notifications
      *   between the Guest UI and the server. When `null`, you must register handlers
-     *   manually using the `oncalltool`, `onlistresources`, etc. setters.
+     *   manually using the {@link oncalltool}, {@link onlistresources}, etc. setters.
      * @param _hostInfo - Host application identification (name and version)
      * @param _capabilities - Features and capabilities the host supports
      * @param options - Configuration options (inherited from Protocol)
@@ -200,7 +219,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * Optional handler for ping requests from the Guest UI.
      *
      * The Guest UI can send standard MCP `ping` requests to verify the connection
-     * is alive. The AppBridge automatically responds with an empty object, but this
+     * is alive. The {@link AppBridge} automatically responds with an empty object, but this
      * handler allows the host to observe or log ping activity.
      *
      * Unlike the other handlers which use setters, this is a direct property
@@ -221,7 +240,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * Register a handler for size change notifications from the Guest UI.
      *
      * The Guest UI sends `ui/notifications/size-changed` when its rendered content
-     * size changes, typically via ResizeObserver. Set this callback to dynamically
+     * size changes, typically via `ResizeObserver`. Set this callback to dynamically
      * adjust the iframe container dimensions based on the Guest UI's content.
      *
      * Note: This is for Guest UI → Host communication. To notify the Guest UI of
@@ -240,7 +259,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * ```
      *
      * @see {@link McpUiSizeChangedNotification} for the notification type
-     * @see {@link app.App.sendSizeChanged} for Host → Guest UI size notifications
+     * @see {@link app!App.sendSizeChanged} - the Guest UI method that sends these notifications
      */
     set onsizechange(callback: (params: McpUiSizeChangedNotification["params"]) => void);
     /**
@@ -305,10 +324,10 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * leakage.
      *
      * @param callback - Handler that receives message params and returns a result
-     *   - params.role - Message role (currently only "user" is supported)
-     *   - params.content - Message content blocks (text, image, etc.)
-     *   - extra - Request metadata (abort signal, session info)
-     *   - Returns: Promise<McpUiMessageResult> with optional isError flag
+     *   - `params.role` - Message role (currently only "user" is supported)
+     *   - `params.content` - Message content blocks (text, image, etc.)
+     *   - `extra` - Request metadata (abort signal, session info)
+     *   - Returns: `Promise<McpUiMessageResult>` with optional `isError` flag
      *
      * @example
      * ```typescript
@@ -341,9 +360,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * - Reject the request entirely
      *
      * @param callback - Handler that receives URL params and returns a result
-     *   - params.url - URL to open in the host's browser
-     *   - extra - Request metadata (abort signal, session info)
-     *   - Returns: Promise<McpUiOpenLinkResult> with optional isError flag
+     *   - `params.url` - URL to open in the host's browser
+     *   - `extra` - Request metadata (abort signal, session info)
+     *   - Returns: `Promise<McpUiOpenLinkResult>` with optional `isError` flag
      *
      * @example
      * ```typescript
@@ -382,17 +401,22 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * If the requested mode is not available, the handler should return the current
      * display mode instead.
      *
+     * By default, `AppBridge` returns the current `displayMode` from host context (or "inline").
+     * Setting this property replaces that default behavior.
+     *
      * @param callback - Handler that receives the requested mode and returns the actual mode set
-     *   - params.mode - The display mode being requested ("inline" | "fullscreen" | "pip")
-     *   - extra - Request metadata (abort signal, session info)
-     *   - Returns: Promise<McpUiRequestDisplayModeResult> with the actual mode set
+     *   - `params.mode` - The display mode being requested ("inline" | "fullscreen" | "pip")
+     *   - `extra` - Request metadata (abort signal, session info)
+     *   - Returns: `Promise<McpUiRequestDisplayModeResult>` with the actual mode set
      *
      * @example
      * ```typescript
+     * let currentDisplayMode: McpUiDisplayMode = "inline";
+     *
      * bridge.onrequestdisplaymode = async ({ mode }, extra) => {
      *   const availableModes = hostContext.availableDisplayModes ?? ["inline"];
      *   if (availableModes.includes(mode)) {
-     *     setDisplayMode(mode);
+     *     currentDisplayMode = mode;
      *     return { mode };
      *   }
      *   // Return current mode if requested mode not available
@@ -416,9 +440,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * message type.
      *
      * @param callback - Handler that receives logging params
-     *   - params.level - Log level: "debug" | "info" | "notice" | "warning" | "error" | "critical" | "alert" | "emergency"
-     *   - params.logger - Optional logger name/identifier
-     *   - params.data - Log message and optional structured data
+     *   - `params.level` - Log level: "debug" | "info" | "notice" | "warning" | "error" | "critical" | "alert" | "emergency"
+     *   - `params.logger` - Optional logger name/identifier
+     *   - `params.data` - Log message and optional structured data
      *
      * @example
      * ```typescript
@@ -432,6 +456,35 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * ```
      */
     set onloggingmessage(callback: (params: LoggingMessageNotification["params"]) => void);
+    /**
+     * Register a handler for model context updates from the Guest UI.
+     *
+     * The Guest UI sends `ui/update-model-context` requests to update the Host's
+     * model context. Each request overwrites the previous context stored by the Guest UI.
+     * Unlike logging messages, context updates are intended to be available to
+     * the model in future turns. Unlike messages, context updates do not trigger follow-ups.
+     *
+     * The host will typically defer sending the context to the model until the
+     * next user message (including `ui/message`), and will only send the last
+     * update received.
+     *
+     * @example
+     * ```typescript
+     * bridge.onupdatemodelcontext = async ({ content, structuredContent }, extra) => {
+     *   // Update the model context with the new snapshot
+     *   modelContext = {
+     *     type: "app_context",
+     *     content,
+     *     structuredContent,
+     *     timestamp: Date.now()
+     *   };
+     *   return {};
+     * };
+     * ```
+     *
+     * @see {@link McpUiUpdateModelContextRequest} for the request type
+     */
+    set onupdatemodelcontext(callback: (params: McpUiUpdateModelContextRequest["params"], extra: RequestHandlerExtra) => Promise<EmptyResult>);
     /**
      * Register a handler for tool call requests from the Guest UI.
      *
@@ -440,9 +493,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * by forwarding them to the MCP server.
      *
      * @param callback - Handler that receives tool call params and returns a
-     *   {@link CallToolResult}
-     * @param callback.params - Tool call parameters (name and arguments)
-     * @param callback.extra - Request metadata (abort signal, session info)
+     *   `CallToolResult`
+     *   - `params` - Tool call parameters (name and arguments)
+     *   - `extra` - Request metadata (abort signal, session info)
      *
      * @example
      * ```typescript
@@ -455,8 +508,8 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * };
      * ```
      *
-     * @see {@link CallToolRequest} for the request type
-     * @see {@link CallToolResult} for the result type
+     * @see `CallToolRequest` from @modelcontextprotocol/sdk for the request type
+     * @see `CallToolResult` from @modelcontextprotocol/sdk for the result type
      */
     set oncalltool(callback: (params: CallToolRequest["params"], extra: RequestHandlerExtra) => Promise<CallToolResult>);
     /**
@@ -476,7 +529,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * });
      * ```
      *
-     * @see {@link ToolListChangedNotification} for the notification type
+     * @see `ToolListChangedNotification` from @modelcontextprotocol/sdk for the notification type
      */
     sendToolListChanged(params?: ToolListChangedNotification["params"]): Promise<void>;
     /**
@@ -487,9 +540,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * requests, typically by forwarding them to the MCP server.
      *
      * @param callback - Handler that receives list params and returns a
-     *   {@link ListResourcesResult}
-     * @param callback.params - Request params (may include cursor for pagination)
-     * @param callback.extra - Request metadata (abort signal, session info)
+     *   `ListResourcesResult`
+     *   - `params` - Request params (may include cursor for pagination)
+     *   - `extra` - Request metadata (abort signal, session info)
      *
      * @example
      * ```typescript
@@ -502,8 +555,8 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * };
      * ```
      *
-     * @see {@link ListResourcesRequest} for the request type
-     * @see {@link ListResourcesResult} for the result type
+     * @see `ListResourcesRequest` from @modelcontextprotocol/sdk for the request type
+     * @see `ListResourcesResult` from @modelcontextprotocol/sdk for the result type
      */
     set onlistresources(callback: (params: ListResourcesRequest["params"], extra: RequestHandlerExtra) => Promise<ListResourcesResult>);
     /**
@@ -514,9 +567,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * these requests, typically by forwarding them to the MCP server.
      *
      * @param callback - Handler that receives list params and returns a
-     *   {@link ListResourceTemplatesResult}
-     * @param callback.params - Request params (may include cursor for pagination)
-     * @param callback.extra - Request metadata (abort signal, session info)
+     *   `ListResourceTemplatesResult`
+     *   - `params` - Request params (may include cursor for pagination)
+     *   - `extra` - Request metadata (abort signal, session info)
      *
      * @example
      * ```typescript
@@ -529,8 +582,8 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * };
      * ```
      *
-     * @see {@link ListResourceTemplatesRequest} for the request type
-     * @see {@link ListResourceTemplatesResult} for the result type
+     * @see `ListResourceTemplatesRequest` from @modelcontextprotocol/sdk for the request type
+     * @see `ListResourceTemplatesResult` from @modelcontextprotocol/sdk for the result type
      */
     set onlistresourcetemplates(callback: (params: ListResourceTemplatesRequest["params"], extra: RequestHandlerExtra) => Promise<ListResourceTemplatesResult>);
     /**
@@ -541,9 +594,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * requests, typically by forwarding them to the MCP server.
      *
      * @param callback - Handler that receives read params and returns a
-     *   {@link ReadResourceResult}
-     * @param callback.params - Read parameters including the resource URI
-     * @param callback.extra - Request metadata (abort signal, session info)
+     *   `ReadResourceResult`
+     *   - `params` - Read parameters including the resource URI
+     *   - `extra` - Request metadata (abort signal, session info)
      *
      * @example
      * ```typescript
@@ -556,8 +609,8 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * };
      * ```
      *
-     * @see {@link ReadResourceRequest} for the request type
-     * @see {@link ReadResourceResult} for the result type
+     * @see `ReadResourceRequest` from @modelcontextprotocol/sdk for the request type
+     * @see `ReadResourceResult` from @modelcontextprotocol/sdk for the result type
      */
     set onreadresource(callback: (params: ReadResourceRequest["params"], extra: RequestHandlerExtra) => Promise<ReadResourceResult>);
     /**
@@ -577,7 +630,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * });
      * ```
      *
-     * @see {@link ResourceListChangedNotification} for the notification type
+     * @see `ResourceListChangedNotification` from @modelcontextprotocol/sdk for the notification type
      */
     sendResourceListChanged(params?: ResourceListChangedNotification["params"]): Promise<void>;
     /**
@@ -588,9 +641,9 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * requests, typically by forwarding them to the MCP server.
      *
      * @param callback - Handler that receives list params and returns a
-     *   {@link ListPromptsResult}
-     * @param callback.params - Request params (may include cursor for pagination)
-     * @param callback.extra - Request metadata (abort signal, session info)
+     *   `ListPromptsResult`
+     *   - `params` - Request params (may include cursor for pagination)
+     *   - `extra` - Request metadata (abort signal, session info)
      *
      * @example
      * ```typescript
@@ -603,8 +656,8 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * };
      * ```
      *
-     * @see {@link ListPromptsRequest} for the request type
-     * @see {@link ListPromptsResult} for the result type
+     * @see `ListPromptsRequest` from @modelcontextprotocol/sdk for the request type
+     * @see `ListPromptsResult` from @modelcontextprotocol/sdk for the result type
      */
     set onlistprompts(callback: (params: ListPromptsRequest["params"], extra: RequestHandlerExtra) => Promise<ListPromptsResult>);
     /**
@@ -624,7 +677,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * });
      * ```
      *
-     * @see {@link PromptListChangedNotification} for the notification type
+     * @see `PromptListChangedNotification` from @modelcontextprotocol/sdk for the notification type
      */
     sendPromptListChanged(params?: PromptListChangedNotification["params"]): Promise<void>;
     /**
@@ -668,9 +721,10 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
     /**
      * Update the host context and notify the Guest UI of changes.
      *
-     * Compares the new context with the current context and sends a
-     * `ui/notifications/host-context-changed` notification containing only the
-     * fields that have changed. If no fields have changed, no notification is sent.
+     * Compares fields present in the new context with the current context and sends a
+     * `ui/notifications/host-context-changed` notification containing only fields
+     * that have been added or modified. If no fields have changed, no notification is sent.
+     * The new context fully replaces the internal state.
      *
      * Common use cases include notifying the Guest UI when:
      * - Theme changes (light/dark mode toggle)
@@ -698,8 +752,13 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      */
     setHostContext(hostContext: McpUiHostContext): void;
     /**
-     * Send a host context change notification to the app.
-     * Only sends the fields that have changed (partial update).
+     * Low-level method to notify the Guest UI of host context changes.
+     *
+     * Most hosts should use {@link setHostContext} instead, which automatically
+     * detects changes and calls this method with only the modified fields.
+     * Use this directly only when you need fine-grained control over change detection.
+     *
+     * @param params - The context fields that have changed (partial update)
      */
     sendHostContextChange(params: McpUiHostContextChangedNotification["params"]): Promise<void> | void;
     /**
@@ -786,7 +845,7 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * any other interruption. This allows the Guest UI to update its state and
      * display appropriate feedback to the user.
      *
-     * @param params - Optional cancellation details:
+     * @param params - Cancellation details object
      *   - `reason`: Human-readable explanation for why the tool was cancelled
      *
      * @example User-initiated cancellation
@@ -863,13 +922,13 @@ export declare class AppBridge extends Protocol<AppRequest, AppNotification, App
      * - Prompts (prompts/list, notifications/prompts/list_changed)
      *
      * If no client was passed to the constructor, no automatic forwarding is set up
-     * and you must register handlers manually using the `oncalltool`, `onlistresources`,
+     * and you must register handlers manually using the {@link oncalltool}, {@link onlistresources},
      * etc. setters.
      *
-     * After calling connect, wait for the `oninitialized` callback before sending
+     * After calling connect, wait for the {@link oninitialized} callback before sending
      * tool input and other data to the Guest UI.
      *
-     * @param transport - Transport layer (typically PostMessageTransport)
+     * @param transport - Transport layer (typically {@link PostMessageTransport})
      * @returns Promise resolving when connection is established
      *
      * @throws {Error} If a client was passed but server capabilities are not available.