mcp-use TypeScript API
    Preparing search index...

    Interface ResourceTemplateDefinition<TUriTemplate>

    Declares a parameterized resource matched by URI template.

    interface ResourceTemplateDefinition<TUriTemplate extends string = string> {
        _meta?: MetaObject;
        annotations?: {};
        complete?: ResourceTemplateCompletions<TUriTemplate>;
        description?: string;
        mimeType?: string;
        name: string;
        title?: string;
        uriTemplate: TUriTemplate;
    }

    Type Parameters

    • TUriTemplate extends string = string

      Literal URI template used to infer read variables and completion keys.

    Index
    _meta? annotations? complete? description? mimeType? name title? uriTemplate

    Optional_meta

    _meta?: MetaObject

    Extension metadata advertised on this template's resources/templates/list descriptor. Use vendor-namespaced keys for custom data.

    This value is not copied into resources/read content entries; content metadata must be returned by the callback on each entry's own _meta.

    annotations?: {}

    Standard MCP hints describing resources produced by this template.

    complete?: ResourceTemplateCompletions<TUriTemplate>

    Optional completion providers keyed by URI-template variable.

    Static arrays use case-insensitive prefix matching. Dynamic callbacks may be synchronous or asynchronous and receive the current value plus the official completion context containing already-resolved arguments.

    description?: string

    Human-readable description.

    mimeType?: string

    MIME type of the content.

    name: string

    Template display name.

    title?: string

    Human-readable title (falls back to name).

    uriTemplate: TUriTemplate

    RFC 6570 URI template with variables, e.g. "db://users/{id}".

    Settings
    Member Visibility

    On This Page
    Properties