@modelcontextprotocol/ext-apps - v1.0.1
    Preparing search index...

    Interface McpUiAppToolConfig

    Configuration for tools that render an interactive UI.

    Extends ToolConfig with a required _meta field that specifies UI metadata. The UI resource can be specified in two ways:

    • _meta.ui.resourceUri (preferred)
    • _meta["ui/resourceUri"] (deprecated, for backward compatibility)

    registerAppTool for the recommended way to register app tools

    interface McpUiAppToolConfig {
        _meta: { [key: string]: unknown } & (
            { ui: McpUiToolMeta }
            | { "ui/resourceUri"?: string }
        );
        annotations?: {
            destructiveHint?: boolean;
            idempotentHint?: boolean;
            openWorldHint?: boolean;
            readOnlyHint?: boolean;
            title?: string;
        };
        description?: string;
        inputSchema?: AnySchema
        | ZodRawShapeCompat;
        outputSchema?: AnySchema | ZodRawShapeCompat;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _meta annotations? description? inputSchema? outputSchema? title?

    Properties

    _meta

    _meta: { [key: string]: unknown } & (
        { ui: McpUiToolMeta }
        | { "ui/resourceUri"?: string }
    )

    Type Declaration

    • [key: string]: unknown
    • { ui: McpUiToolMeta }
    • { "ui/resourceUri"?: string }
      • Optionalui/resourceUri?: string

        URI of the UI resource to display for this tool. This is converted to _meta["ui/resourceUri"].

        Use _meta.ui.resourceUri instead.

    annotations?: {
        destructiveHint?: boolean;
        idempotentHint?: boolean;
        openWorldHint?: boolean;
        readOnlyHint?: boolean;
        title?: string;
    }
    description?: string
    inputSchema?: AnySchema | ZodRawShapeCompat
    outputSchema?: AnySchema | ZodRawShapeCompat
    title?: string

    Settings

    Member Visibility

    On This Page

    Properties