@modelcontextprotocol/ext-apps 0.4.0 → 0.4.1

package/dist/src/spec.types.d.ts

@@ -2,7 +2,7 @@
  * MCP Apps Protocol Types (spec.types.ts)
  *
  * This file contains pure TypeScript interface definitions for the MCP Apps protocol.
- * These types are the source of truth and are used to generate Zod schemas via ts-to-zod.
+ * These types are the source of truth and are used to generate Zod schemas via `ts-to-zod`.
  *
  * - Use `@description` JSDoc tags to generate `.describe()` calls on schemas
  * - Run `npm run generate:schemas` to regenerate schemas from these types
@@ -41,7 +41,7 @@ export type McpUiStyleVariableKey = "--color-background-primary" | "--color-back
 export type McpUiStyles = Record<McpUiStyleVariableKey, string | undefined>;
 /**
  * @description Request to open an external URL in the host's default browser.
- * @see {@link app.App.sendOpenLink} for the method that sends this request
+ * @see {@link app!App.openLink} for the method that sends this request
  */
 export interface McpUiOpenLinkRequest {
     method: "ui/open-link";
@@ -59,13 +59,13 @@ export interface McpUiOpenLinkResult {
     isError?: boolean;
     /**
      * Index signature required for MCP SDK `Protocol` class compatibility.
-     * Note: The schema intentionally omits this to enforce strict validation.
+     * Note: The generated schema uses passthrough() to allow additional properties.
      */
     [key: string]: unknown;
 }
 /**
  * @description Request to send a message to the host's chat interface.
- * @see {@link app.App.sendMessage} for the method that sends this request
+ * @see {@link app!App.sendMessage} for the method that sends this request
  */
 export interface McpUiMessageRequest {
     method: "ui/message";
@@ -85,7 +85,7 @@ export interface McpUiMessageResult {
     isError?: boolean;
     /**
      * Index signature required for MCP SDK `Protocol` class compatibility.
-     * Note: The schema intentionally omits this to enforce strict validation.
+     * Note: The generated schema uses passthrough() to allow additional properties.
      */
     [key: string]: unknown;
 }
@@ -117,8 +117,8 @@ export interface McpUiSandboxResourceReadyNotification {
     };
 }
 /**
- * @description Notification of UI size changes (bidirectional: Guest <-> Host).
- * @see {@link app.App.sendSizeChanged} for the method to send this from Guest UI
+ * @description Notification of UI size changes (Guest UI -> Host).
+ * @see {@link app!App.sendSizeChanged} for the method to send this from Guest UI
  */
 export interface McpUiSizeChangedNotification {
     method: "ui/notifications/size-changed";
@@ -173,7 +173,7 @@ export interface McpUiToolCancelledNotification {
  * @description CSS blocks that can be injected by apps.
  */
 export interface McpUiHostCss {
-    /** @description CSS for font loading (@font-face rules or @import statements). Apps must apply using applyHostFonts(). */
+    /** @description CSS for font loading (`@font-face` rules or `@import` statements). Apps must apply using {@link applyHostFonts}. */
     fonts?: string;
 }
 /**
@@ -282,7 +282,7 @@ export interface McpUiUpdateModelContextRequest {
 }
 /**
  * @description Request for graceful shutdown of the Guest UI (Host -> Guest UI).
- * @see {@link app-bridge.AppBridge.teardownResource} for the host method that sends this
+ * @see {@link app-bridge!AppBridge.teardownResource} for the host method that sends this
  */
 export interface McpUiResourceTeardownRequest {
     method: "ui/resource-teardown";
@@ -346,7 +346,7 @@ export interface McpUiHostCapabilities {
     message?: McpUiSupportedContentBlockModalities;
 }
 /**
- * @description Capabilities provided by the Guest UI (App).
+ * @description Capabilities provided by the Guest UI ({@link app!App}).
  * @see {@link McpUiInitializeRequest} for the initialization request that includes these capabilities
  */
 export interface McpUiAppCapabilities {
@@ -360,7 +360,7 @@ export interface McpUiAppCapabilities {
 }
 /**
  * @description Initialization request sent from Guest UI to Host.
- * @see {@link app.App.connect} for the method that sends this request
+ * @see {@link app!App.connect} for the method that sends this request
  */
 export interface McpUiInitializeRequest {
     method: "ui/initialize";
@@ -388,13 +388,13 @@ export interface McpUiInitializeResult {
     hostContext: McpUiHostContext;
     /**
      * Index signature required for MCP SDK `Protocol` class compatibility.
-     * Note: The schema intentionally omits this to enforce strict validation.
+     * Note: The generated schema uses passthrough() to allow additional properties.
      */
     [key: string]: unknown;
 }
 /**
  * @description Notification that Guest UI has completed initialization (Guest UI -> Host).
- * @see {@link app.App.connect} for the method that sends this notification
+ * @see {@link app!App.connect} for the method that sends this notification
  */
 export interface McpUiInitializedNotification {
     method: "ui/notifications/initialized";
@@ -445,7 +445,7 @@ export interface McpUiResourceMeta {
  * @description Request to change the display mode of the UI.
  * The host will respond with the actual display mode that was set,
  * which may differ from the requested mode if not supported.
- * @see {@link app.App.requestDisplayMode} for the method that sends this request
+ * @see {@link app!App.requestDisplayMode} for the method that sends this request
  */
 export interface McpUiRequestDisplayModeRequest {
     method: "ui/request-display-mode";
@@ -463,7 +463,7 @@ export interface McpUiRequestDisplayModeResult {
     mode: McpUiDisplayMode;
     /**
      * Index signature required for MCP SDK `Protocol` class compatibility.
-     * Note: The schema intentionally omits this to enforce strict validation.
+     * Note: The generated schema uses passthrough() to allow additional properties.
      */
     [key: string]: unknown;
 }

package/dist/src/styles.d.ts

@@ -58,12 +58,12 @@ export declare function applyDocumentTheme(theme: McpUiTheme): void;
 /**
  * Apply host style variables as CSS custom properties on an element.
  *
- * This function takes the `variables` object from `McpUiHostContext.styles` and sets
+ * This function takes the `variables` object from {@link McpUiHostContext.styles} and sets
  * each CSS variable on the specified root element (defaults to `document.documentElement`).
  * This allows apps to use the host's theming values via CSS variables like
  * `var(--color-background-primary)`.
  *
- * @param styles - The styles object from `McpUiHostContext.styles.variables`
+ * @param styles - The style variables object from `McpUiHostContext.styles.variables`
  * @param root - The element to apply styles to (defaults to `document.documentElement`)
  *
  * @example Apply style variables from host context
@@ -95,10 +95,10 @@ export declare function applyHostStyleVariables(styles: McpUiStyles, root?: HTML
  * self-hosted fonts, `@import` statements for Google Fonts or other font services,
  * or a combination of both.
  *
- * The styles are only injected once. Subsequent calls will not create duplicate
- * style tags.
+ * The styles are only injected once. Subsequent calls are no-ops and will not
+ * create duplicate style tags.
  *
- * @param fontCss - CSS string containing @font-face rules and/or @import statements
+ * @param fontCss - CSS string containing `@font-face` rules and/or `@import` statements
  *
  * @example Apply fonts from host context
  * ```typescript

package/dist/src/types.d.ts

@@ -1,12 +1,12 @@
 /**
  * MCP Apps Protocol Types and Schemas
  *
- * This file re-exports types from spec.types.ts and schemas from generated/schema.ts.
- * Compile-time verification is handled by generated/schema.test.ts.
+ * This file re-exports types from `spec.types.ts` and schemas from `generated/schema.ts`.
+ * Compile-time verification is handled by `generated/schema.test.ts`.
  *
- * @see spec.types.ts for the source of truth TypeScript interfaces
- * @see generated/schema.ts for auto-generated Zod schemas
- * @see generated/schema.test.ts for compile-time verification
+ * @see `spec.types.ts` for the source of truth TypeScript interfaces
+ * @see `generated/schema.ts` for auto-generated Zod schemas
+ * @see `generated/schema.test.ts` for compile-time verification
  */
 export { LATEST_PROTOCOL_VERSION, OPEN_LINK_METHOD, MESSAGE_METHOD, SANDBOX_PROXY_READY_METHOD, SANDBOX_RESOURCE_READY_METHOD, SIZE_CHANGED_METHOD, TOOL_INPUT_METHOD, TOOL_INPUT_PARTIAL_METHOD, TOOL_RESULT_METHOD, TOOL_CANCELLED_METHOD, HOST_CONTEXT_CHANGED_METHOD, RESOURCE_TEARDOWN_METHOD, INITIALIZE_METHOD, INITIALIZED_METHOD, REQUEST_DISPLAY_MODE_METHOD, type McpUiTheme, type McpUiDisplayMode, type McpUiStyleVariableKey, type McpUiStyles, type McpUiHostCss, type McpUiHostStyles, type McpUiOpenLinkRequest, type McpUiOpenLinkResult, type McpUiMessageRequest, type McpUiMessageResult, type McpUiUpdateModelContextRequest, type McpUiSupportedContentBlockModalities, type McpUiSandboxProxyReadyNotification, type McpUiSandboxResourceReadyNotification, type McpUiSizeChangedNotification, type McpUiToolInputNotification, type McpUiToolInputPartialNotification, type McpUiToolResultNotification, type McpUiToolCancelledNotification, type McpUiHostContext, type McpUiHostContextChangedNotification, type McpUiResourceTeardownRequest, type McpUiResourceTeardownResult, type McpUiHostCapabilities, type McpUiAppCapabilities, type McpUiInitializeRequest, type McpUiInitializeResult, type McpUiInitializedNotification, type McpUiResourceCsp, type McpUiResourcePermissions, type McpUiResourceMeta, type McpUiRequestDisplayModeRequest, type McpUiRequestDisplayModeResult, type McpUiToolVisibility, type McpUiToolMeta, } from "./spec.types.js";
 import type { McpUiInitializeRequest, McpUiOpenLinkRequest, McpUiMessageRequest, McpUiUpdateModelContextRequest, McpUiResourceTeardownRequest, McpUiRequestDisplayModeRequest, McpUiHostContextChangedNotification, McpUiToolInputNotification, McpUiToolInputPartialNotification, McpUiToolResultNotification, McpUiToolCancelledNotification, McpUiSandboxResourceReadyNotification, McpUiInitializedNotification, McpUiSizeChangedNotification, McpUiSandboxProxyReadyNotification, McpUiInitializeResult, McpUiOpenLinkResult, McpUiMessageResult, McpUiResourceTeardownResult, McpUiRequestDisplayModeResult } from "./spec.types.js";
@@ -17,7 +17,8 @@ import { CallToolRequest, CallToolResult, EmptyResult, ListPromptsRequest, ListP
  *
  * Includes:
  * - MCP UI requests (initialize, open-link, message, resource-teardown, request-display-mode)
- * - MCP server requests forwarded from the app (tools/call, resources/*, prompts/list)
+ * - MCP server requests forwarded from the app (tools/call, tools/list, resources/list,
+ *   resources/templates/list, resources/read, prompts/list)
  * - Protocol requests (ping)
  */
 export type AppRequest = McpUiInitializeRequest | McpUiOpenLinkRequest | McpUiMessageRequest | McpUiUpdateModelContextRequest | McpUiResourceTeardownRequest | McpUiRequestDisplayModeRequest | CallToolRequest | ListToolsRequest | ListResourcesRequest | ListResourceTemplatesRequest | ReadResourceRequest | ListPromptsRequest | PingRequest;

package/package.json

@@ -5,7 +5,7 @@
     "url": "https://github.com/modelcontextprotocol/ext-apps"
   },
   "homepage": "https://github.com/modelcontextprotocol/ext-apps",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "license": "MIT",
   "description": "MCP Apps SDK — Enable MCP servers to display interactive user interfaces in conversational clients.",
   "type": "module",
@@ -54,8 +54,8 @@
     "test:e2e": "playwright test",
     "test:e2e:update": "playwright test --update-snapshots",
     "test:e2e:ui": "playwright test --ui",
-    "test:e2e:docker": "docker run --rm -v $(pwd):/work -w /work -it mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'npm i -g bun && npm ci && npx playwright test'",
-    "test:e2e:docker:update": "docker run --rm -v $(pwd):/work -w /work -it mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'npm i -g bun && npm ci && npx playwright test --update-snapshots'",
+    "test:e2e:docker": "docker run --rm -v $(pwd):/work -w /work -it mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'apt-get update -qq && apt-get install -qq -y python3-venv curl > /dev/null && curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH=\"$HOME/.local/bin:$PATH\" && npm i -g bun && npm ci && npx playwright test'",
+    "test:e2e:docker:update": "npm run build:all && docker run --rm -v $(pwd):/work -w /work -it mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'apt-get update -qq && apt-get install -qq -y python3-venv curl > /dev/null && curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH=\"$HOME/.local/bin:$PATH\" && npm i -g bun && npm ci && npx playwright test --update-snapshots'",
     "preexamples:build": "npm run build",
     "examples:build": "bun examples/run-all.ts build",
     "examples:start": "NODE_ENV=development npm run build && bun examples/run-all.ts start",
@@ -64,6 +64,7 @@
     "prepare": "node scripts/setup-bun.mjs && npm run build && husky",
     "docs": "typedoc",
     "docs:watch": "typedoc --watch",
+    "generate:screenshots": "npm run build:all && docker run --rm -v $(pwd):/work -w /work mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'apt-get update -qq && apt-get install -qq -y python3-venv curl > /dev/null && curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH=\"$HOME/.local/bin:$PATH\" && npm i -g bun && npm ci && npx playwright test tests/e2e/generate-grid-screenshots.spec.ts'",
     "prettier": "prettier -u \"**/*.{js,jsx,ts,tsx,mjs,json,md,yml,yaml}\" --check",
     "prettier:fix": "prettier -u \"**/*.{js,jsx,ts,tsx,mjs,json,md,yml,yaml}\" --write",
     "check:versions": "node scripts/check-versions.mjs"
@@ -85,6 +86,7 @@
     "prettier": "^3.6.2",
     "react": "^19.2.0",
     "react-dom": "^19.2.0",
+    "sharp": "^0.34.5",
     "ts-to-zod": "^5.1.0",
     "tsx": "^4.21.0",
     "typedoc": "^0.28.14",