tool

The tool block defines an external tool or integration that agents can use.

Syntax

tool <name> {
  name         = <string>
  desc         = <string>  // optional
  input_schema = <schema>  // optional
  invoke       = <string>  // optional
}

Fields

Field	Type	Required	Description
name	str	Yes	The tool's identifier
desc	str | null	No	A description of what the tool does
input_schema	schema | null	No	Schema describing the tool's input parameters
invoke	str | null	No	Fully-qualified Python function to call when the tool is invoked

Examples

Simple tool

tool search {
  name = "web_search"
  desc = "Search the web for current information"
}

tool gmail {
  name = "gmail"
  desc = "Send and read emails via Gmail"
}

tool slack {
  name = "slack"
  desc = "Send messages to Slack channels"
}

Tool with input schema and invoke

schema search_input {
  query   = str
  max_results = int | null
}

tool search {
  name         = "web_search"
  desc         = "Search the web for current information"
  input_schema = search_input
  invoke       = "myapp.tools.web_search"
}

Using tools with agents

Reference tool blocks in an agent's tools list:

agent assistant {
  model   = gpt4
  persona = "You help users with tasks."
  tools   = [search, gmail, slack]
}