Package io.micronaut.mcp.annotations

Annotation Interface Tool

@Documented @Retention(RUNTIME) @Target(METHOD) public @interface Tool
Method annotation to define an MCP Tool. Tools Micronaut registers Tools singletons for beans with executable methods (e.g. methods in a class annotated with `@Singleton`) annotated with Tool. Forked from: https://github.com/quarkiverse/quarkus-mcp-server/blob/main/core/runtime/src/main/java/io/quarkiverse/mcp/server/Tool.java

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
     
    String
    name
    Each tool must have a unique name.
    String
    title
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT_NAME
    Constant value for name() indicating that the annotated element's name should be used as-is.

  • Field Details

    • ELEMENT_NAME

      static final String ELEMENT_NAME
      Constant value for name() indicating that the annotated element's name should be used as-is.
      See Also:

  • Element Details

    • name

      String name
      Each tool must have a unique name. By default, the name is derived from the name of the annotated method.
      Returns:
      "<<element name>>"
      Default:
      "<<element name>>"

    • title

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

    • description

      String description
      Returns:
      A human-readable description of the tool. A hint to the model.
      Default:
      ""