@modelcontextprotocol/sdk
    Preparing search index...

    Interface Resource

    A known resource that the server is capable of reading.

    interface Resource {
        _meta?: { [key: string]: unknown };
        annotations?: Annotations;
        description?: string;
        icons?: Icon[];
        mimeType?: string;
        name: string;
        size?: number;
        title?: string;
        uri: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _meta?: { [key: string]: unknown }

    See General fields: _meta for notes on _meta usage.

    annotations?: Annotations

    Optional annotations for the client.

    description?: string

    A description of what this resource represents.

    This can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a "hint" to the model.

    icons?: Icon[]

    Optional set of sized icons that the client can display in a user interface.

    Clients that support rendering icons MUST support at least the following MIME types:

    • image/png - PNG images (safe, universal compatibility)
    • image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)

    Clients that support rendering icons SHOULD also support:

    • image/svg+xml - SVG images (scalable but requires security precautions)
    • image/webp - WebP images (modern, efficient format)
    mimeType?: string

    The MIME type of this resource, if known.

    name: string

    Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).

    size?: number

    The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.

    This can be used by Hosts to display file sizes and estimate context window usage.

    title?: string

    Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.

    If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).

    uri: string

    The URI of this resource.

    uri