Package io.micronaut.mcp.annotations
Annotation Interface ToolArg
Annotates a parameter of a
Tool
method.
Forked from: https://github.com/quarkiverse/quarkus-mcp-server/blob/main/core/runtime/src/main/java/io/quarkiverse/mcp/server/ToolArg.java-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionThe description of the tool argument.The name of the tool argument. -
Field Summary
Fields
-
Field Details
-
ELEMENT_NAME
Constant value forname()
indicating that the annotated element's name should be used as-is.- See Also:
-
-
Element Details
-
name
String nameThe name of the tool argument. If not specified, the parameter name will be used.- Returns:
- the name of the argument
- Default:
- "<<element name>>"
-
description
String descriptionThe description of the tool argument. This description will be included in the JSON schema for the tool, providing documentation for users of the MCP tool.- Returns:
- the description of the argument, or empty string if not specified
- Default:
- ""
-