MCP Server Framework - v1.0.0
    Preparing search index...

    Interface ToolAnnotations

    Tool annotations providing behavioral hints per MCP specification.

    These help clients understand tool characteristics without parsing descriptions. All properties are optional and represent hints — not guarantees.

    https://modelcontextprotocol.io/specification/2025-03-26/server/tools#annotations

    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 operations (default assumption: true)

    idempotentHint?: boolean

    If true, calling the tool repeatedly with the same args has no additional effect

    openWorldHint?: boolean

    If true, the tool interacts with external entities beyond its own system

    readOnlyHint?: boolean

    If true, the tool does not modify any external state (default assumption: false)

    title?: string

    Human-readable title for display purposes

    Settings

    Member Visibility

    On This Page

    Properties