Package org.springframework.ai.tool.annotation

Annotation Interface ToolParam

@Target({PARAMETER,FIELD,ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented public @interface ToolParam
Marks a tool argument.
Since:
1.0.0
Author:
Thomas Vitale

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    The description of the tool argument.
    boolean
    required
    Whether the tool argument is required.

  • Element Details

    • required

      boolean required
      Whether the tool argument is required.
      Default:
      true

    • description

      String description
      The description of the tool argument.
      Default:
      ""