MCP Apps
    Preparing search index...

    Interface UseAppOptions

    Options for configuring the useApp hook.

    • useApp for the hook that uses these options
    • useAutoResize for manual auto-resize control with custom App options
    interface UseAppOptions {
        appInfo: {
            description?: string;
            icons?: {
                mimeType?: string;
                sizes?: string[];
                src: string;
                theme?: "light" | "dark";
            }[];
            name: string;
            title?: string;
            version: string;
            websiteUrl?: string;
        };
        autoResize?: boolean;
        capabilities: McpUiAppCapabilities;
        onAppCreated?: (app: App) => void;
    }
    Index

    Properties

    appInfo autoResize? capabilities onAppCreated?

    Properties

    appInfo: {
        description?: string;
        icons?: {
            mimeType?: string;
            sizes?: string[];
            src: string;
            theme?: "light" | "dark";
        }[];
        name: string;
        title?: string;
        version: string;
        websiteUrl?: string;
    }

    App identification (name and version)

    autoResize?: boolean

    Automatically report size changes to the host.

    Disable this for apps that manage their own height (canvases, editors, diagrams) or that use viewport-relative sizing like 100vh, and call app.sendSizeChanged manually instead.

    true
    capabilities: McpUiAppCapabilities

    Declares what features this app supports.

    onAppCreated?: (app: App) => void

    Called after App is created but before connection.

    Use this to register request/notification handlers that need to be in place before the initialization handshake completes.

    Type Declaration

      • (app: App): void

      • Parameters

        • app: App

          The newly created App instance

        Returns void

    useApp({
      appInfo: { name: "MyApp", version: "1.0.0" },
      capabilities: {},
      onAppCreated: (app) => {
        app.ontoolresult = (result) => {
          console.log("Tool result:", result);
        };
      },
    });

    Settings

    Member Visibility

    On This Page

    Properties