@modelcontextprotocol/ext-apps 0.2.2 → 0.3.1

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

@@ -28,7 +28,7 @@ export type McpUiDisplayMode = "inline" | "fullscreen" | "pip";
 /**
  * @description CSS variable keys available to MCP apps for theming.
  */
-export type McpUiStyleVariableKey = "--color-background-primary" | "--color-background-secondary" | "--color-background-tertiary" | "--color-background-inverse" | "--color-background-ghost" | "--color-background-info" | "--color-background-danger" | "--color-background-success" | "--color-background-warning" | "--color-background-disabled" | "--color-text-primary" | "--color-text-secondary" | "--color-text-tertiary" | "--color-text-inverse" | "--color-text-info" | "--color-text-danger" | "--color-text-success" | "--color-text-warning" | "--color-text-disabled" | "--color-text-ghost" | "--color-border-primary" | "--color-border-secondary" | "--color-border-tertiary" | "--color-border-inverse" | "--color-border-ghost" | "--color-border-info" | "--color-border-danger" | "--color-border-success" | "--color-border-warning" | "--color-border-disabled" | "--color-ring-primary" | "--color-ring-secondary" | "--color-ring-inverse" | "--color-ring-info" | "--color-ring-danger" | "--color-ring-success" | "--color-ring-warning" | "--font-sans" | "--font-mono" | "--font-weight-normal" | "--font-weight-medium" | "--font-weight-semibold" | "--font-weight-bold" | "--font-text-xs-size" | "--font-text-sm-size" | "--font-text-md-size" | "--font-text-lg-size" | "--font-heading-xs-size" | "--font-heading-sm-size" | "--font-heading-md-size" | "--font-heading-lg-size" | "--font-heading-xl-size" | "--font-heading-2xl-size" | "--font-heading-3xl-size" | "--font-text-xs-line-height" | "--font-text-sm-line-height" | "--font-text-md-line-height" | "--font-text-lg-line-height" | "--font-heading-xs-line-height" | "--font-heading-sm-line-height" | "--font-heading-md-line-height" | "--font-heading-lg-line-height" | "--font-heading-xl-line-height" | "--font-heading-2xl-line-height" | "--font-heading-3xl-line-height" | "--border-radius-xs" | "--border-radius-sm" | "--border-radius-md" | "--border-radius-lg" | "--border-radius-xl" | "--border-radius-full" | "--border-width-regular" | "--shadow-hairline" | "--shadow-sm" | "--shadow-md" | "--shadow-lg";
+export type McpUiStyleVariableKey = "--color-background-primary" | "--color-background-secondary" | "--color-background-tertiary" | "--color-background-inverse" | "--color-background-ghost" | "--color-background-info" | "--color-background-danger" | "--color-background-success" | "--color-background-warning" | "--color-background-disabled" | "--color-text-primary" | "--color-text-secondary" | "--color-text-tertiary" | "--color-text-inverse" | "--color-text-ghost" | "--color-text-info" | "--color-text-danger" | "--color-text-success" | "--color-text-warning" | "--color-text-disabled" | "--color-text-ghost" | "--color-border-primary" | "--color-border-secondary" | "--color-border-tertiary" | "--color-border-inverse" | "--color-border-ghost" | "--color-border-info" | "--color-border-danger" | "--color-border-success" | "--color-border-warning" | "--color-border-disabled" | "--color-ring-primary" | "--color-ring-secondary" | "--color-ring-inverse" | "--color-ring-info" | "--color-ring-danger" | "--color-ring-success" | "--color-ring-warning" | "--font-sans" | "--font-mono" | "--font-weight-normal" | "--font-weight-medium" | "--font-weight-semibold" | "--font-weight-bold" | "--font-text-xs-size" | "--font-text-sm-size" | "--font-text-md-size" | "--font-text-lg-size" | "--font-heading-xs-size" | "--font-heading-sm-size" | "--font-heading-md-size" | "--font-heading-lg-size" | "--font-heading-xl-size" | "--font-heading-2xl-size" | "--font-heading-3xl-size" | "--font-text-xs-line-height" | "--font-text-sm-line-height" | "--font-text-md-line-height" | "--font-text-lg-line-height" | "--font-heading-xs-line-height" | "--font-heading-sm-line-height" | "--font-heading-md-line-height" | "--font-heading-lg-line-height" | "--font-heading-xl-line-height" | "--font-heading-2xl-line-height" | "--font-heading-3xl-line-height" | "--border-radius-xs" | "--border-radius-sm" | "--border-radius-md" | "--border-radius-lg" | "--border-radius-xl" | "--border-radius-full" | "--border-width-regular" | "--shadow-hairline" | "--shadow-sm" | "--shadow-md" | "--shadow-lg";
 /**
  * @description Style variables for theming MCP apps.
  *
@@ -197,7 +197,7 @@ export interface McpUiHostContext {
     /** @description Metadata of the tool call that instantiated this App. */
     toolInfo?: {
         /** @description JSON-RPC id of the tools/call request. */
-        id: RequestId;
+        id?: RequestId;
         /** @description Tool definition including name, inputSchema, etc. */
         tool: Tool;
     };
@@ -209,17 +209,23 @@ export interface McpUiHostContext {
     displayMode?: McpUiDisplayMode;
     /** @description Display modes the host supports. */
     availableDisplayModes?: string[];
-    /** @description Current and maximum dimensions available to the UI. */
-    viewport?: {
-        /** @description Current viewport width in pixels. */
-        width: number;
-        /** @description Current viewport height in pixels. */
+    /**
+     * @description Container dimensions. Represents the dimensions of the iframe or other
+     * container holding the app. Specify either width or maxWidth, and either height or maxHeight.
+     */
+    containerDimensions?: ({
+        /** @description Fixed container height in pixels. */
         height: number;
-        /** @description Maximum available height in pixels (if constrained). */
-        maxHeight?: number;
-        /** @description Maximum available width in pixels (if constrained). */
-        maxWidth?: number;
-    };
+    } | {
+        /** @description Maximum container height in pixels. */
+        maxHeight?: number | undefined;
+    }) & ({
+        /** @description Fixed container width in pixels. */
+        width: number;
+    } | {
+        /** @description Maximum container width in pixels. */
+        maxWidth?: number | undefined;
+    });
     /** @description User's language and region preference in BCP 47 format. */
     locale?: string;
     /** @description User's timezone in IANA format. */
@@ -406,12 +412,12 @@ export type McpUiToolVisibility = "model" | "app";
  */
 export interface McpUiToolMeta {
     /**
-     * URI of the UI resource to display for this tool.
+     * URI of the UI resource to display for this tool, if any.
      * This is converted to `_meta["ui/resourceUri"]`.
      *
      * @example "ui://weather/widget.html"
      */
-    resourceUri: string;
+    resourceUri?: string;
     /**
      * @description Who can access this tool. Default: ["model", "app"]
      * - "model": Tool visible to and callable by the agent
@@ -419,3 +425,33 @@ export interface McpUiToolMeta {
      */
     visibility?: McpUiToolVisibility[];
 }
+/**
+ * Method string constants for MCP Apps protocol messages.
+ *
+ * These constants provide a type-safe way to check message methods without
+ * accessing internal Zod schema properties. External libraries should use
+ * these constants instead of accessing `schema.shape.method._def.values[0]`.
+ *
+ * @example
+ * ```typescript
+ * import { SANDBOX_PROXY_READY_METHOD } from '@modelcontextprotocol/ext-apps';
+ *
+ * if (event.data.method === SANDBOX_PROXY_READY_METHOD) {
+ *   // Handle sandbox proxy ready notification
+ * }
+ * ```
+ */
+export declare const OPEN_LINK_METHOD: McpUiOpenLinkRequest["method"];
+export declare const MESSAGE_METHOD: McpUiMessageRequest["method"];
+export declare const SANDBOX_PROXY_READY_METHOD: McpUiSandboxProxyReadyNotification["method"];
+export declare const SANDBOX_RESOURCE_READY_METHOD: McpUiSandboxResourceReadyNotification["method"];
+export declare const SIZE_CHANGED_METHOD: McpUiSizeChangedNotification["method"];
+export declare const TOOL_INPUT_METHOD: McpUiToolInputNotification["method"];
+export declare const TOOL_INPUT_PARTIAL_METHOD: McpUiToolInputPartialNotification["method"];
+export declare const TOOL_RESULT_METHOD: McpUiToolResultNotification["method"];
+export declare const TOOL_CANCELLED_METHOD: McpUiToolCancelledNotification["method"];
+export declare const HOST_CONTEXT_CHANGED_METHOD: McpUiHostContextChangedNotification["method"];
+export declare const RESOURCE_TEARDOWN_METHOD: McpUiResourceTeardownRequest["method"];
+export declare const INITIALIZE_METHOD: McpUiInitializeRequest["method"];
+export declare const INITIALIZED_METHOD: McpUiInitializedNotification["method"];
+export declare const REQUEST_DISPLAY_MODE_METHOD: McpUiRequestDisplayModeRequest["method"];

package/dist/src/types.d.ts

@@ -8,7 +8,7 @@
  * @see generated/schema.ts for auto-generated Zod schemas
  * @see generated/schema.test.ts for compile-time verification
  */
-export { LATEST_PROTOCOL_VERSION, type McpUiTheme, type McpUiDisplayMode, type McpUiStyleVariableKey, type McpUiStyles, type McpUiHostCss, type McpUiHostStyles, type McpUiOpenLinkRequest, type McpUiOpenLinkResult, type McpUiMessageRequest, type McpUiMessageResult, 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 McpUiResourceMeta, type McpUiRequestDisplayModeRequest, type McpUiRequestDisplayModeResult, type McpUiToolVisibility, type McpUiToolMeta, } from "./spec.types.js";
+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 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 McpUiResourceMeta, type McpUiRequestDisplayModeRequest, type McpUiRequestDisplayModeResult, type McpUiToolVisibility, type McpUiToolMeta, } from "./spec.types.js";
 import type { McpUiInitializeRequest, McpUiOpenLinkRequest, McpUiMessageRequest, McpUiResourceTeardownRequest, McpUiRequestDisplayModeRequest, McpUiHostContextChangedNotification, McpUiToolInputNotification, McpUiToolInputPartialNotification, McpUiToolResultNotification, McpUiToolCancelledNotification, McpUiSandboxResourceReadyNotification, McpUiInitializedNotification, McpUiSizeChangedNotification, McpUiSandboxProxyReadyNotification, McpUiInitializeResult, McpUiOpenLinkResult, McpUiMessageResult, McpUiResourceTeardownResult, McpUiRequestDisplayModeResult } from "./spec.types.js";
 export { McpUiThemeSchema, McpUiDisplayModeSchema, McpUiHostCssSchema, McpUiHostStylesSchema, McpUiOpenLinkRequestSchema, McpUiOpenLinkResultSchema, McpUiMessageRequestSchema, McpUiMessageResultSchema, McpUiSandboxProxyReadyNotificationSchema, McpUiSandboxResourceReadyNotificationSchema, McpUiSizeChangedNotificationSchema, McpUiToolInputNotificationSchema, McpUiToolInputPartialNotificationSchema, McpUiToolResultNotificationSchema, McpUiToolCancelledNotificationSchema, McpUiHostContextSchema, McpUiHostContextChangedNotificationSchema, McpUiResourceTeardownRequestSchema, McpUiResourceTeardownResultSchema, McpUiHostCapabilitiesSchema, McpUiAppCapabilitiesSchema, McpUiInitializeRequestSchema, McpUiInitializeResultSchema, McpUiInitializedNotificationSchema, McpUiResourceCspSchema, McpUiResourceMetaSchema, McpUiRequestDisplayModeRequestSchema, McpUiRequestDisplayModeResultSchema, McpUiToolVisibilitySchema, McpUiToolMetaSchema, } from "./generated/schema.js";
 import { CallToolRequest, CallToolResult, EmptyResult, ListPromptsRequest, ListPromptsResult, ListResourcesRequest, ListResourcesResult, ListResourceTemplatesRequest, ListResourceTemplatesResult, ListToolsRequest, ListToolsResult, LoggingMessageNotification, PingRequest, PromptListChangedNotification, ReadResourceRequest, ReadResourceResult, ResourceListChangedNotification, ToolListChangedNotification } from "@modelcontextprotocol/sdk/types.js";

package/package.json

@@ -5,7 +5,7 @@
     "url": "https://github.com/modelcontextprotocol/ext-apps"
   },
   "homepage": "https://github.com/modelcontextprotocol/ext-apps",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "license": "MIT",
   "description": "MCP Apps SDK — Enable MCP servers to display interactive user interfaces in conversational clients.",
   "type": "module",
@@ -15,10 +15,18 @@
       "types": "./dist/src/app.d.ts",
       "default": "./dist/src/app.js"
     },
+    "./app-with-deps": {
+      "types": "./dist/src/app.d.ts",
+      "default": "./dist/src/app-with-deps.js"
+    },
     "./react": {
       "types": "./dist/src/react/index.d.ts",
       "default": "./dist/src/react/index.js"
     },
+    "./react-with-deps": {
+      "types": "./dist/src/react/index.d.ts",
+      "default": "./dist/src/react/react-with-deps.js"
+    },
     "./app-bridge": {
       "types": "./dist/src/app-bridge.d.ts",
       "default": "./dist/src/app-bridge.js"
@@ -37,16 +45,18 @@
   ],
   "scripts": {
     "postinstall": "node scripts/setup-bun.mjs || echo 'setup-bun.mjs failed or not available'",
+    "start": "npm run examples:start",
     "generate:schemas": "tsx scripts/generate-schemas.ts && prettier --write \"src/generated/**/*\"",
     "build": "npm run generate:schemas && node scripts/run-bun.mjs build.bun.ts",
     "prepack": "npm run build",
-    "build:all": "npm run build && npm run examples:build",
+    "build:all": "npm run examples:build",
     "test": "bun test src",
     "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'",
+    "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",
     "examples:dev": "NODE_ENV=development bun examples/run-all.ts dev",
@@ -55,7 +65,8 @@
     "docs": "typedoc",
     "docs:watch": "typedoc --watch",
     "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"
+    "prettier:fix": "prettier -u \"**/*.{js,jsx,ts,tsx,mjs,json,md,yml,yaml}\" --write",
+    "check:versions": "node scripts/check-versions.mjs"
   },
   "author": "Olivier Chafik",
   "devDependencies": {
@@ -71,6 +82,7 @@
     "express": "^5.1.0",
     "husky": "^9.1.7",
     "nodemon": "^3.1.0",
+    "prettier": "^3.6.2",
     "react": "^19.2.0",
     "react-dom": "^19.2.0",
     "ts-to-zod": "^5.1.0",
@@ -93,9 +105,6 @@
       "optional": true
     }
   },
-  "dependencies": {
-    "prettier": "^3.6.2"
-  },
   "optionalDependencies": {
     "@oven/bun-darwin-aarch64": "^1.2.21",
     "@oven/bun-darwin-x64": "^1.2.21",
@@ -112,6 +121,7 @@
     "@rollup/rollup-darwin-x64": "^4.53.3",
     "@rollup/rollup-linux-arm64-gnu": "^4.53.3",
     "@rollup/rollup-linux-x64-gnu": "^4.53.3",
+    "@rollup/rollup-win32-arm64-msvc": "^4.53.3",
     "@rollup/rollup-win32-x64-msvc": "^4.53.3"
   }
 }