Skip to contents

tool_param

Source: R/04_Tool.R
tool_param.Rd

Define a tool parameter schema

Usage

tool_param(name, type, description, required = FALSE)

Arguments

name

Character: The name of the parameter.

type

Character: The type of the parameter.

description

Character: The description of the parameter.

required

Logical: Whether the parameter is required.

Value

ToolParameter object

Author

EDG

Examples

tool_param("query", "string", "search query to send", required = TRUE)
#>        name: query
#>        type: string
#> description: search query to send
#>    required: TRUE
#>