@modelcontextprotocol/ext-apps 0.4.0 → 0.4.1

package/LICENSE

@@ -1,6 +1,193 @@
+The MCP project is undergoing a licensing transition from the MIT License to the Apache License, Version 2.0 ("Apache-2.0"). All new code and specification contributions to the project are licensed under Apache-2.0. Documentation contributions (excluding specifications) are licensed under CC-BY-4.0.
+
+Contributions for which relicensing consent has been obtained are licensed under Apache-2.0. Contributions made by authors who originally licensed their work under the MIT License and who have not yet granted explicit permission to relicense remain licensed under the MIT License.
+
+No rights beyond those granted by the applicable original license are conveyed for such contributions.
+
+---
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright
+      owner or by an individual or Legal Entity authorized to submit on behalf
+      of the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+---
+
 MIT License
 
-Copyright (c) 2025 Anthropic, PBC
+Copyright (c) 2024-2025 Model Context Protocol a Series of LF Projects, LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +206,11 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+---
+
+Creative Commons Attribution 4.0 International (CC-BY-4.0)
+
+Documentation in this project (excluding specifications) is licensed under
+CC-BY-4.0. See https://creativecommons.org/licenses/by/4.0/legalcode for
+the full license text.

package/README.md

@@ -56,19 +56,30 @@ Or edit your `package.json` manually:
 
 ## Examples
 
-Start with these foundational examples to learn the SDK:
-
-- [`examples/basic-server-vanillajs`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vanillajs) — MCP server + MCP App using vanilla JS
-- [`examples/basic-server-react`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-react) — MCP server + MCP App using [React](https://github.com/facebook/react)
-- [`examples/basic-server-vue`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-vue) — MCP server + MCP App using [Vue](https://github.com/vuejs/vue)
-- [`examples/basic-server-svelte`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-svelte) — MCP server + MCP App using [Svelte](https://github.com/sveltejs/svelte)
-- [`examples/basic-server-preact`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-preact) — MCP server + MCP App using [Preact](https://github.com/preactjs/preact)
-- [`examples/basic-server-solid`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-server-solid) — MCP server + MCP App using [Solid](https://github.com/solidjs/solid)
-- [`examples/basic-host`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-host) — MCP host application supporting MCP Apps
+<!-- prettier-ignore-start -->
+| | | |
+|:---:|:---:|:---:|
+| [![Map](examples/map-server/grid-cell.png "Interactive 3D globe viewer using CesiumJS")](examples/map-server) | [![Three.js](examples/threejs-server/grid-cell.png "Interactive 3D scene renderer")](examples/threejs-server) | [![ShaderToy](examples/shadertoy-server/grid-cell.png "Real-time GLSL shader renderer")](examples/shadertoy-server) |
+| [**Map**](examples/map-server) | [**Three.js**](examples/threejs-server) | [**ShaderToy**](examples/shadertoy-server) |
+| [![Sheet Music](examples/sheet-music-server/grid-cell.png "ABC notation to sheet music")](examples/sheet-music-server) | [![Wiki Explorer](examples/wiki-explorer-server/grid-cell.png "Wikipedia link graph visualization")](examples/wiki-explorer-server) | [![Cohort Heatmap](examples/cohort-heatmap-server/grid-cell.png "Customer retention heatmap")](examples/cohort-heatmap-server) |
+| [**Sheet Music**](examples/sheet-music-server) | [**Wiki Explorer**](examples/wiki-explorer-server) | [**Cohort Heatmap**](examples/cohort-heatmap-server) |
+| [![Scenario Modeler](examples/scenario-modeler-server/grid-cell.png "SaaS business projections")](examples/scenario-modeler-server) | [![Budget Allocator](examples/budget-allocator-server/grid-cell.png "Interactive budget allocation")](examples/budget-allocator-server) | [![Customer Segmentation](examples/customer-segmentation-server/grid-cell.png "Scatter chart with clustering")](examples/customer-segmentation-server) |
+| [**Scenario Modeler**](examples/scenario-modeler-server) | [**Budget Allocator**](examples/budget-allocator-server) | [**Customer Segmentation**](examples/customer-segmentation-server) |
+| [![System Monitor](examples/system-monitor-server/grid-cell.png "Real-time OS metrics")](examples/system-monitor-server) | [![Transcript](examples/transcript-server/grid-cell.png "Live speech transcription")](examples/transcript-server) | [![Video Resource](examples/video-resource-server/grid-cell.png "Binary video via MCP resources")](examples/video-resource-server) |
+| [**System Monitor**](examples/system-monitor-server) | [**Transcript**](examples/transcript-server) | [**Video Resource**](examples/video-resource-server) |
+| [![PDF Server](examples/pdf-server/grid-cell.png "Interactive PDF viewer with chunked loading")](examples/pdf-server) | [![QR Code](examples/qr-server/grid-cell.png "QR code generator")](examples/qr-server) | |
+| [**PDF Server**](examples/pdf-server) | [**QR Code (Python)**](examples/qr-server) | |
+
+### Starter Templates
+
+| | |
+|:---:|:---|
+| [![Basic](examples/basic-server-react/grid-cell.png "Starter template")](examples/basic-server-react) | The same app built with different frameworks — pick your favorite!<br><br>[React](examples/basic-server-react) · [Vue](examples/basic-server-vue) · [Svelte](examples/basic-server-svelte) · [Preact](examples/basic-server-preact) · [Solid](examples/basic-server-solid) · [Vanilla JS](examples/basic-server-vanillajs) |
+<!-- prettier-ignore-end -->
 
 The [`examples/`](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples) directory contains additional demo apps showcasing real-world use cases.
 
-To run all examples together:
+To run all examples:
 
 ```bash
 npm install

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

@@ -1,6 +1,6 @@
 import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
-import { CallToolRequest, CallToolResult, EmptyResult, 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, McpUiUpdateModelContextRequest, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiInitializedNotification, McpUiMessageRequest, McpUiMessageResult, McpUiOpenLinkRequest, McpUiOpenLinkResult, McpUiResourceTeardownRequest, McpUiSandboxProxyReadyNotification, McpUiRequestDisplayModeRequest, McpUiRequestDisplayModeResult, McpUiResourcePermissions } from "./types";
 export * from "./types";
@@ -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,9 +30,7 @@ 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;
 /**
  * Build iframe `allow` attribute string from permissions.
  *
@@ -51,9 +49,12 @@ export declare function getToolUiResourceUri(tool: {
  */
 export declare function buildAllowAttribute(permissions: McpUiResourcePermissions | undefined): string;
 /**
- * Options for configuring AppBridge behavior.
+ * Options for configuring {@link AppBridge} behavior.
  *
- * @see ProtocolOptions from @modelcontextprotocol/sdk for available options
+ * @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;
@@ -68,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.
  *
@@ -76,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
  *
@@ -93,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
@@ -147,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)
@@ -217,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
@@ -238,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
@@ -257,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);
     /**
@@ -322,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
@@ -358,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
@@ -399,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
@@ -433,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
@@ -486,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
@@ -501,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>);
     /**
@@ -522,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>;
     /**
@@ -533,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
@@ -548,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>);
     /**
@@ -560,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
@@ -575,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>);
     /**
@@ -587,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
@@ -602,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>);
     /**
@@ -623,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>;
     /**
@@ -634,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
@@ -649,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>);
     /**
@@ -670,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>;
     /**
@@ -714,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)
@@ -744,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;
     /**
@@ -832,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
@@ -909,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.