Param

Kotlin |Java

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

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

Summary

Public constructors
`Param(description: String, required: Boolean)`

Public properties
`String`	`description` A description of what the parameter represents.
`Boolean`	`required` Indicates whether the parameter is mandatory.

Param(description: String, required: Boolean = true)

val description: String

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

val required: Boolean

Indicates whether the parameter is mandatory. Defaults to true.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-07-15 UTC.