Annotation Interface AgiToolParam

@Retention(RUNTIME) @Target(PARAMETER) public @interface AgiToolParam
Provides a description for a parameter of a method marked with AgiTool. This is essential for the model to understand how to use the tool correctly, as it is used to generate the JSON schema for the tool's arguments.
Author:
anahata-gemini-pro-2.5

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    A clear and concise description of the parameter's purpose and expected format.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    rendererId
    The ID of a specialized renderer that should be used to display the value of this parameter in the UI (e.g., 'java', 'path', 'markdown').
    boolean
    required
    Determines whether this parameter is mandatory for the tool call.

  • Element Details

    • value

      String value
      A clear and concise description of the parameter's purpose and expected format. This is injected into the tool's JSON schema as the property description.
      Returns:
      The description of this parameter.

    • required

      boolean required
      Determines whether this parameter is mandatory for the tool call.
      Returns:
      true if the parameter is required, false otherwise.
      Default:
      true

    • rendererId

      String rendererId
      The ID of a specialized renderer that should be used to display the value of this parameter in the UI (e.g., 'java', 'path', 'markdown').
      Returns:
      The renderer ID, or an empty string for default rendering.
      Default:
      ""