Annotation Interface McpTool

@Target({METHOD,ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented public @interface McpTool
Author:
Christian Tzolov, Alexandros Pappas, Vadzim Shurmialiou, Craig Walls

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    McpTool.McpAnnotations
    Additional properties describing a Tool to clients.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    McpTool.McpAnnotations
    annotations
    Additional hints for clients.
    String
    description
    The description of the tool.
    boolean
    generateOutputSchema
    If true, the tool will generate an output schema for non-primitive output types.
    Class<? extends MetaProvider>
    metaProvider
    "_meta" field for the tool declaration.
    String
    name
    The name of the tool.
    String
    title
    Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.

  • Element Details

    • name

      String name
      The name of the tool. If not provided, the method name will be used.
      Default:
      ""

    • description

      String description
      The description of the tool. If not provided, the method name will be used.
      Default:
      ""

    • annotations

      McpTool.McpAnnotations annotations
      Additional hints for clients.
      Default:
      @org.springframework.ai.mcp.annotation.McpTool.McpAnnotations

    • generateOutputSchema

      boolean generateOutputSchema
      If true, the tool will generate an output schema for non-primitive output types. If false, the tool will not automatically generate an output schema.
      Default:
      false

    • title

      String title
      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).
      Default:
      ""

    • metaProvider

      Class<? extends MetaProvider> metaProvider
      "_meta" field for the tool declaration. If not provided, no "_meta" appended to the tool specification.
      Default:
      org.springframework.ai.mcp.annotation.context.DefaultMetaProvider.class