@modelcontextprotocol/sdk
    Preparing search index...

    Interface ToolAnnotations

    Additional properties describing a Tool to clients.

    NOTE: all properties in ToolAnnotations are hints. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like title).

    Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers.

    interface ToolAnnotations {
        destructiveHint?: boolean;
        idempotentHint?: boolean;
        openWorldHint?: boolean;
        readOnlyHint?: boolean;
        title?: string;
    }
    Index

    Properties

    destructiveHint? idempotentHint? openWorldHint? readOnlyHint? title?

    Properties

    destructiveHint?: boolean

    If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.

    (This property is meaningful only when readOnlyHint == false)

    Default: true

    idempotentHint?: boolean

    If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment.

    (This property is meaningful only when readOnlyHint == false)

    Default: false

    openWorldHint?: boolean

    If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.

    Default: true

    readOnlyHint?: boolean

    If true, the tool does not modify its environment.

    Default: false

    title?: string

    A human-readable title for the tool.

    Settings

    Member Visibility

    On This Page

    Properties