@modelcontextprotocol/sdk
    Preparing search index...

    Interface PromptArgument

    Describes an argument that a prompt can accept.

    interface PromptArgument {
        description?: string;
        name: string;
        required?: boolean;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description?: string

    A human-readable description of the argument.

    name: string

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

    required?: boolean

    Whether this argument must be provided.

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