Param

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
@Retention(value = AnnotationRetention.RUNTIME)
public annotation Param

Annotates a parameter in a Tool function to provide metadata for the tool's schema.

Summary

Public constructors
Param(@NonNull String description, boolean required)

Public methods
final @NonNull String

A description of what the parameter represents.
final boolean

Indicates whether the parameter is mandatory.

Public constructors

Param

public Param(@NonNull String description, boolean required)

Public methods

getDescription

public final @NonNull String getDescription()

A description of what the parameter represents. This helps the model understand the expected input.

getRequired

public final boolean getRequired()

Indicates whether the parameter is mandatory. Defaults to true.