@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface AdcpMcpResourceDefinition

    Declarative registration for one static HTML MCP App resource.

    The framework registers the resource on both the legacy MCP SDK server and every modern per-request server reconstruction. The handler returns the complete HTML document; the framework owns the URI, MIME type, and metadata in the resources/read response so discovery and readback cannot drift.

    interface AdcpMcpResourceDefinition {
        name: string;
        uri: `ui://${string}`;
        title?: string;
        description?: string;
        mimeType?: "text/html;profile=mcp-app";
        _meta?: McpAppResourceMeta;
        handler: (
            uri: URL,
            ctx: McpAppResourceReadContext,
        ) => string | Promise<string>;
    }
    Index

    Properties

    name uri title? description? mimeType? _meta? handler

    Properties

    name: string

    Stable programmatic name surfaced by resources/list.

    uri: `ui://${string}`

    MCP Apps require the ui:// URI scheme.

    title?: string
    description?: string
    mimeType?: "text/html;profile=mcp-app"

    Defaults to the only MIME type currently supported by MCP Apps.

    Optional_meta

    _meta?: McpAppResourceMeta
    handler: (uri: URL, ctx: McpAppResourceReadContext) => string | Promise<string>

    Settings

    Member Visibility

    On This Page

    Properties