@modelcontextprotocol/ext-apps 0.1.0 → 0.2.0

package/dist/src/app.d.ts

@@ -1,9 +1,11 @@
 import { type RequestOptions, Protocol, ProtocolOptions } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { CallToolRequest, CallToolResult, Implementation, ListToolsRequest, LoggingMessageNotification, Notification, Request, Result } from "@modelcontextprotocol/sdk/types.js";
-import { McpUiAppCapabilities, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiMessageRequest, McpUiOpenLinkRequest, McpUiResourceTeardownRequest, McpUiResourceTeardownResult, McpUiSizeChangedNotification, McpUiToolCancelledNotification, McpUiToolInputNotification, McpUiToolInputPartialNotification, McpUiToolResultNotification } from "./types";
+import { CallToolRequest, CallToolResult, Implementation, ListToolsRequest, LoggingMessageNotification } from "@modelcontextprotocol/sdk/types.js";
+import { AppNotification, AppRequest, AppResult } from "./types";
+import { McpUiAppCapabilities, McpUiHostCapabilities, McpUiHostContext, McpUiHostContextChangedNotification, McpUiMessageRequest, McpUiOpenLinkRequest, McpUiResourceTeardownRequest, McpUiResourceTeardownResult, McpUiSizeChangedNotification, McpUiToolCancelledNotification, McpUiToolInputNotification, McpUiToolInputPartialNotification, McpUiToolResultNotification, McpUiRequestDisplayModeRequest } from "./types";
 import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
 export { PostMessageTransport } from "./message-transport";
 export * from "./types";
+export { applyHostStyleVariables, getDocumentTheme, applyDocumentTheme, } from "./styles";
 /**
  * Metadata key for associating a resource URI with a tool call.
  *
@@ -137,7 +139,7 @@ type RequestHandlerExtra = Parameters<Parameters<App["setRequestHandler"]>[1]>[1
  * });
  * ```
  */
-export declare class App extends Protocol<Request, Notification, Result> {
+export declare class App extends Protocol<AppRequest, AppNotification, AppResult> {
     private _appInfo;
     private _capabilities;
     private options;
@@ -498,17 +500,17 @@ export declare class App extends Protocol<Request, Notification, Result> {
      * Verify that the host supports the capability required for the given request method.
      * @internal
      */
-    assertCapabilityForMethod(method: Request["method"]): void;
+    assertCapabilityForMethod(method: AppRequest["method"]): void;
     /**
      * Verify that the app declared the capability required for the given request method.
      * @internal
      */
-    assertRequestHandlerCapability(method: Request["method"]): void;
+    assertRequestHandlerCapability(method: AppRequest["method"]): void;
     /**
      * Verify that the app supports the capability required for the given notification method.
      * @internal
      */
-    assertNotificationCapability(method: Notification["method"]): void;
+    assertNotificationCapability(method: AppNotification["method"]): void;
     /**
      * Verify that task creation is supported for the given request method.
      * @internal
@@ -622,7 +624,7 @@ export declare class App extends Protocol<Request, Notification, Result> {
      * @example Open documentation link
      * ```typescript
      * try {
-     *   await app.sendOpenLink({ url: "https://docs.example.com" });
+     *   await app.openLink({ url: "https://docs.example.com" });
      * } catch (error) {
      *   console.error("Failed to open link:", error);
      *   // Optionally show fallback: display URL for manual copy
@@ -631,10 +633,40 @@ export declare class App extends Protocol<Request, Notification, Result> {
      *
      * @see {@link McpUiOpenLinkRequest} for request structure
      */
-    sendOpenLink(params: McpUiOpenLinkRequest["params"], options?: RequestOptions): Promise<{
+    openLink(params: McpUiOpenLinkRequest["params"], options?: RequestOptions): Promise<{
         [x: string]: unknown;
         isError?: boolean | undefined;
     }>;
+    /** @deprecated Use {@link openLink} instead */
+    sendOpenLink: App["openLink"];
+    /**
+     * Request a change to the display mode.
+     *
+     * Requests the host to change the UI container to the specified display mode
+     * (e.g., "inline", "fullscreen", "pip"). The host will respond with the actual
+     * display mode that was set, which may differ from the requested mode if
+     * the requested mode is not available (check `availableDisplayModes` in host context).
+     *
+     * @param params - The display mode being requested
+     * @param options - Request options (timeout, etc.)
+     * @returns Result containing the actual display mode that was set
+     *
+     * @example Request fullscreen mode
+     * ```typescript
+     * const context = app.getHostContext();
+     * if (context?.availableDisplayModes?.includes("fullscreen")) {
+     *   const result = await app.requestDisplayMode({ mode: "fullscreen" });
+     *   console.log("Display mode set to:", result.mode);
+     * }
+     * ```
+     *
+     * @see {@link McpUiRequestDisplayModeRequest} for request structure
+     * @see {@link McpUiHostContext} for checking availableDisplayModes
+     */
+    requestDisplayMode(params: McpUiRequestDisplayModeRequest["params"], options?: RequestOptions): Promise<{
+        [x: string]: unknown;
+        mode: "inline" | "fullscreen" | "pip";
+    }>;
     /**
      * Notify the host of UI size changes.
      *
@@ -719,5 +751,5 @@ export declare class App extends Protocol<Request, Notification, Result> {
      * @see {@link McpUiInitializedNotification} for the initialized notification
      * @see {@link PostMessageTransport} for the typical transport implementation
      */
-    connect(transport: Transport, options?: RequestOptions): Promise<void>;
+    connect(transport?: Transport, options?: RequestOptions): Promise<void>;
 }