@modelcontextprotocol/sdk
    Preparing search index...

    Interface Prompt

    A prompt or prompt template that the server offers.

    interface Prompt {
        _meta?: { [key: string]: unknown };
        arguments?: PromptArgument[];
        description?: string;
        icons?: Icon[];
        name: string;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _meta? arguments? description? icons? name title?

    Properties

    Optional_meta

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

    See General fields: _meta for notes on _meta usage.

    arguments?: PromptArgument[]

    A list of arguments to use for templating the prompt.

    description?: string

    An optional description of what this prompt provides

    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)
    name: string

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

    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).

    Settings

    Member Visibility

    On This Page

    Properties