tool: Tool Class
In aisdk: Unified Interface for AI Model Providers
Tool R Documentation
Tool Class
Description
R6 class representing a callable tool for LLM function calling.
A Tool connects an LLM's tool call request to an R function.
Public fields
nameThe unique name of the tool.
descriptionA description of what the tool does.
parametersA z_object schema defining the tool's parameters.
layerTool layer: "llm" (loaded into context) or "computer" (executed via bash/filesystem).
metaOptional metadata for the tool (e.g., caching configuration).
Methods
Public methods
Method new()
Initialize a Tool.
Usage
Tool$new(name, description, parameters, execute, layer = "llm", meta = NULL)
Arguments
nameUnique tool name (used by LLM to call the tool).
descriptionDescription of the tool's purpose.
parametersA z_object schema defining expected parameters.
executeAn R function that implements the tool logic.
layerTool layer: "llm" or "computer" (default: "llm").
metaOptional metadata list (e.g., cache_control).
Method to_api_format()
Convert tool to API format.
Usage
Tool$to_api_format(provider = "openai")
Arguments
providerProvider name ("openai" or "anthropic"). Default "openai".
Returns
A list in the format expected by the API.
Method run()
Execute the tool with given arguments.
Usage
Tool$run(args, envir = NULL)
Arguments
argsA list or named list of arguments.
envirOptional environment in which to evaluate the tool function.
When provided, the environment is passed as .envir in the args list,
allowing the execute function to access and modify session variables.
Returns
The result of executing the tool function.
Method print()
Print method for Tool.
Usage
Tool$print()
Method clone()
The objects of this class are cloneable with this method.
Usage
Tool$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
aisdk documentation built on May 29, 2026, 9:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Tool | R Documentation |
Tool Class
Description
R6 class representing a callable tool for LLM function calling. A Tool connects an LLM's tool call request to an R function.
Public fields
nameThe unique name of the tool.
descriptionA description of what the tool does.
parametersA z_object schema defining the tool's parameters.
layerTool layer: "llm" (loaded into context) or "computer" (executed via bash/filesystem).
metaOptional metadata for the tool (e.g., caching configuration).
Methods
Public methods
Method new()
Initialize a Tool.
Usage
Tool$new(name, description, parameters, execute, layer = "llm", meta = NULL)
Arguments
nameUnique tool name (used by LLM to call the tool).
descriptionDescription of the tool's purpose.
parametersA z_object schema defining expected parameters.
executeAn R function that implements the tool logic.
layerTool layer: "llm" or "computer" (default: "llm").
metaOptional metadata list (e.g., cache_control).
Method to_api_format()
Convert tool to API format.
Usage
Tool$to_api_format(provider = "openai")
Arguments
providerProvider name ("openai" or "anthropic"). Default "openai".
Returns
A list in the format expected by the API.
Method run()
Execute the tool with given arguments.
Usage
Tool$run(args, envir = NULL)
Arguments
argsA list or named list of arguments.
envirOptional environment in which to evaluate the tool function. When provided, the environment is passed as
.envirin the args list, allowing the execute function to access and modify session variables.
Returns
The result of executing the tool function.
Method print()
Print method for Tool.
Usage
Tool$print()
Method clone()
The objects of this class are cloneable with this method.
Usage
Tool$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.