google-adk-kotlin-core/com.google.adk.kt.annotations/Param

Param

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Param(val description: String = "", val name: String = "", val required: Requiredness = Requiredness.AUTO)

Annotates a parameter of a function annotated with Tool to provide explicit metadata.

Properties

description

val description: String

An optional explicit description for the parameter. If not provided, the @param tag from the KDoc is used.

name

val name: String

An optional explicit name for the parameter. When set, both the KSP path and com.google.adk.kt.interop.ReflectiveTools use it as the schema name; when unset, the KSP path uses the Kotlin parameter name, while the reflective path requires it because Java does not retain parameter names in bytecode.

required

val required: Requiredness

Whether the parameter is required; see Requiredness. Honored by both paths, defaulting to Requiredness.AUTO.