Package org.springaicommunity.mcp.annotation

Annotation Interface McpTool.McpAnnotations

Enclosing class:
McpTool
@Retention(RUNTIME) @Target(ANNOTATION_TYPE) public static @interface McpTool.McpAnnotations
Additional properties describing a Tool to clients. 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.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    destructiveHint
    If true, the tool may perform destructive updates to its environment.
    boolean
    idempotentHint
    If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.
    boolean
    openWorldHint
    If true, this tool may interact with an “open world” of external entities.
    boolean
    readOnlyHint
    If true, the tool does not modify its environment.
    String
    title
    A human-readable title for the tool.

  • Element Details

    • title

      String title
      A human-readable title for the tool.
      Default:
      ""

    • readOnlyHint

      boolean readOnlyHint
      If true, the tool does not modify its environment.
      Default:
      false

    • destructiveHint

      boolean destructiveHint
      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 idempotentHint
      If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment. (This property is meaningful only when readOnlyHint == false)
      Default:
      false

    • openWorldHint

      boolean openWorldHint
      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