MCP Apps
    Preparing search index...

    Interface McpUiToolMeta

    UI-related metadata for tools.

    interface McpUiToolMeta {
        csp?: undefined;
        entrypoints?: McpUiEntrypoint[];
        permissions?: undefined;
        resourceUri?: string;
        visibility?: McpUiToolVisibility[];
    }
    Index

    Properties

    csp? entrypoints? permissions? resourceUri? visibility?

    Properties

    csp?: undefined

    csp belongs on the UI resource (see McpUiResourceMeta), not the tool. Hosts read it from the resources/read content item (with resources/list entry as fallback) and ignore it here.

    entrypoints?: McpUiEntrypoint[]

    Ways for the user to open this tool's view from the host's own UI. Only has an effect on a tool that declares a UI resource. To ignore malformed entries as the specification requires, read it with the SDK's getToolEntrypoints(): McpUiToolMetaSchema rejects the whole object for one.

    permissions?: undefined

    permissions belongs on the UI resource (see McpUiResourceMeta), not the tool. Hosts ignore it here.

    resourceUri?: string

    URI of the UI resource to display for this tool, if any.

    "ui://weather/view.html"
    visibility?: McpUiToolVisibility[]

    Who can access this tool. Default: ["model", "app"]

    • "model": Tool visible to and callable by the agent
    • "app": Tool callable by the app from this server only

    Settings

    Member Visibility

    On This Page

    Properties