Comparator Tool API/io.fletchly.comparator.annotation/ToolParameter

ToolParameter

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class ToolParameter(val description: String, val required: Boolean = true)

Annotation for defining metadata for a tool function parameter.

This annotation is intended to provide descriptive information and constraints for a parameter of a function annotated with ToolFunction. It serves as a mechanism to define behavior and documentation for the parameter within a tool-based system.

Properties

description

val description: String

A textual description of the parameter's purpose or role in the function.

required

val required: Boolean = true

Indicates whether this parameter is mandatory. Defaults to true.