mcp-use TypeScript API
    Preparing search index...

    Interface WidgetMetadata

    Metadata accepted by resources/<name>/widget.tsx during v1 compatibility discovery.

    Export native v2 viewConfig from views/<name>/view.tsx and bind resource facts on the server tool. Removed in mcp-use v3.

    interface WidgetMetadata {
        _meta?: UnknownObject;
        annotations?: UnknownObject;
        appsSdkMetadata?: UnknownObject;
        description?: string;
        exposeAsTool?: boolean;
        inputs?: unknown[] | StandardSchemaWithJSON<unknown, unknown>;
        metadata?: {
            autoResize?: boolean;
            csp?: UnknownObject;
            description?: string;
            domain?: string;
            invoked?: string;
            invoking?: string;
            prefersBorder?: boolean;
            widgetDescription?: string;
        };
        props?: unknown[]
        | StandardSchemaWithJSON<unknown, unknown>;
        schema?: unknown[] | StandardSchemaWithJSON<unknown, unknown>;
        title?: string;
        toolOutput?:
            | { [key: string]: unknown }
            | (
                (
                    params: UnknownObject,
                ) => { [key: string]: unknown } | Promise<{ [key: string]: unknown }>
            );
    }
    Index
    _meta? annotations? appsSdkMetadata? description? exposeAsTool? inputs? metadata? props? schema? title? toolOutput?

    Optional_meta

    _meta?: UnknownObject

    Extension metadata.

    annotations?: UnknownObject

    Tool/resource annotations used by the compatibility registration.

    appsSdkMetadata?: UnknownObject

    Legacy OpenAI Apps SDK resource metadata.

    description?: string

    Widget description.

    exposeAsTool?: boolean

    Whether CLI discovery auto-registers a same-named tool.

    inputs?: unknown[] | StandardSchemaWithJSON<unknown, unknown>

    Deprecated alias for props.

    metadata?: {
        autoResize?: boolean;
        csp?: UnknownObject;
        description?: string;
        domain?: string;
        invoked?: string;
        invoking?: string;
        prefersBorder?: boolean;
        widgetDescription?: string;
    }

    Unified legacy widget metadata.

    Type Declaration

    • OptionalautoResize?: boolean

      Whether the v2 bootstrap automatically reports size changes.

    • Optionalcsp?: UnknownObject

      MCP Apps CSP.

    • Optionaldescription?: string

      Resource description.

    • Optionaldomain?: string

      Dedicated view domain.

    • Optionalinvoked?: string

      Completion status text.

    • Optionalinvoking?: string

      Invocation status text.

    • OptionalprefersBorder?: boolean

      Host border preference.

    • OptionalwidgetDescription?: string

      Human-readable Apps SDK widget summary.

    props?: unknown[] | StandardSchemaWithJSON<unknown, unknown>

    Widget props/input schema.

    schema?: unknown[] | StandardSchemaWithJSON<unknown, unknown>

    Deprecated alias for props.

    title?: string

    Widget title.

    toolOutput?:
        | { [key: string]: unknown }
        | (
            (
                params: UnknownObject,
            ) => { [key: string]: unknown } | Promise<{ [key: string]: unknown }>
        )

    Model-facing output for an auto-registered widget tool.

    Settings
    Member Visibility

    On This Page
    Properties