Tool Reference
🔵 Tools are YAML files in config/agents/<agent>/tools/. The kind: field
selects the engine. Below is a summary table of all engines with links to sections,
so you don't have to read anything extra.
Engine Table
| Engine | What it does | Section |
|---|---|---|
site_tool |
declarative HTTP/API client: scraping + field extraction + formatting | Data Collection and Search |
rest_tool |
alias for site_tool for REST/API integrations (method/body/oauth2) |
Data Collection and Search |
browser_tool |
headless browser (JS sites, clicks, in-page script) | Data Collection and Search |
archive_tool |
search over a local archive | Data Collection and Search |
json_tool |
search over preloaded JSON | Data Collection and Search |
rss_tool |
search over RSS feeds | Data Collection and Search |
pdf_tool |
page-by-page PDF reading | Data Collection and Search |
geo_tool |
geocoding and places (OpenStreetMap) | Data Collection and Search |
rasp_tool |
transport schedules (Yandex.Schedules, free key) | Data Collection and Search |
web_search |
internet search (FireCrawl; searchers module) |
searchers Module |
read_file / write_file / edit_file / list_files / grep / run_command |
working with project code (code module) |
code Module |
supervisor |
launching children, subscriptions, self-inject, session viewing (supervisor module) |
supervisor Module |
machine_list / machine_get / machine_upsert / machine_delete |
inventory of managed machines (remote module) |
remote Module |
ssh_exec / ssh_upload / ssh_download / remote_health |
commands and file transfer over SSH/SCP under per-machine policy (remote module) |
remote Module |
kernel_list / kernel_get / kernel_upsert / kernel_delete |
registry of remote Agent OS cores (kernels module) |
kernels Module |
kernel_health / kernel_models / kernel_agents / kernel_templates / kernel_request |
HTTP API of a remote core (kernels module) |
kernels Module |
kernel_service / kernel_logs / kernel_deploy |
core lifecycle over SSH and distribution deployment (kernels module) |
kernels Module |
state_tool |
scoped state storage | State, Databases, and Visualization |
scratch_tool |
files in the session draft (list/read/write/edit/delete/mkdir/move) | State, Databases, and Visualization |
duckdb_tool |
the agent's own DuckDB database (raw SQL or declarative operations:) |
State, Databases, and Visualization |
sql_tool |
SQL access to an external PostgreSQL/MySQL | State, Databases, and Visualization |
chart_tool / table_tool |
static chart/table | State, Databases, and Visualization |
visualize_tool |
charts/tables from arbitrary data | State, Databases, and Visualization |
map_tool |
map with markers (Leaflet; osm/google/yandex/2gis/custom providers) | State, Databases, and Visualization |
script_tool |
Rhai or JavaScript script | Computation and Actions |
subagent_tool |
delegate a task to a subagent | Computation and Actions |
email_tool |
send an email (SMTP) | Computation and Actions |
vk_tool |
call the VK API on behalf of a community (posts, messages, search) | Computation and Actions |
ym_tool |
send messages/files to Yandex Messenger on behalf of a bot (Bot API) | Computation and Actions |
shell_tool |
run a CLI command | Computation and Actions |
workflow_tool |
run a workflow | Computation and Actions |
file_tool |
send a file to the user | Computation and Actions |
office_tool |
generate/read Word/Excel/PowerPoint (wrapper over OfficeCLI) | Computation and Actions |
storage_tool |
files on S3/WebDAV/FTP (list/get/put/delete) | Computation and Actions |
calendar_tool |
read and manage Google Calendar (service account) | Computation and Actions |
google_tool |
Google Drive / Sheets / Docs / Slides (service account) | Computation and Actions |
yandex_tool |
Yandex.Disk / Yandex.Calendar (user OAuth, service field) |
Computation and Actions |
vision_tool |
OCR/image analysis with a vision model (one or more) | Computation and Actions |
request_attachment |
request a file / screenshot / photo from the user (agent-initiated) | Computation and Actions |
ask_user |
form for the user: multiple questions (text/textarea/number/select/multiselect/confirm/date), "custom option" | Computation and Actions |
notify_tool |
get the user's attention (silent/notify/alert/alarm/call) | Computation and Actions |
oauth_connect |
request connector authorization from the user (OAuth) | Computation and Actions |
connector_request |
authorized request through a connector on behalf of the user | Computation and Actions |
await_event |
pause the flow and wait for an external event (webhook/timer) | Computation and Actions |
async_action |
full asynchronous flow: request → show URL → callback → result | Computation and Actions |
show_link |
show the user a link as a button (window on click) | Computation and Actions |
wait_tool |
pause for N seconds (polling timing for long operations) | Computation and actions |
image_tool |
image processing (crop/resize/grayscale/rotate/flip/brightness/contrast/blur/format) | Computation and actions |
image_gen_tool |
generate an image from a prompt via a configurable URL backend (Pollinations by default) | Computation and actions |
mcp_tool |
external MCP server tool (stdio / HTTP / SSE) | Computation and actions |
trace_tool |
queries to agent traces | Observability and debugging |
human_approval |
ask a human for a decision (approve/reject) | Action approval |
escalate_to_operator |
hand off the dialog to a live operator (or return a contact) | Computation and actions |
dll_tool |
native tool from a Rust DLL (C ABI) | Native plugins |
http_fetch / fs_read / job_done |
built-in tools | Basics |
common fields, ui, blocks, warnings |
general YAML mechanics | Basics |
| templates and variables | MiniJinja | Basics |
| local testing | agent-os tool <yaml> '<args>' |
Observability and debugging |
Sections
- Basics — common fields, templates, built-in tools.
- Data collection and search —
site_tool,browser_tool,archive_tool,json_tool,rss_tool,pdf_tool,geo_tool. - State, databases, and visualization —
state_tool,scratch_tool,duckdb_tool,sql_tool,chart_tool/table_tool,visualize_tool,map_tool. - Computation and actions —
script_tool,subagent_tool,email_tool,vk_tool,ym_tool,shell_tool,workflow_tool,file_tool,office_tool,storage_tool,calendar_tool,google_tool,vision_tool,image_tool,image_gen_tool,mcp_tool,wait_tool. - Observability and debugging —
trace_tool, local testing. - Module
searchers— web search: toolweb_search, demo agentsearchers-demo, FireCrawl key. - Module
code— working with project code:read_file,write_file,edit_file,list_files,grep,run_command; agentcoder. - Module
supervisor— launching child agents and supervision: subscriptions to child events, self-inject, session viewing. - Module
remote— inventory of managed machines and operations over SSH/SCP (machine_*,ssh_exec/ssh_upload/ssh_download,remote_health) under per-machine policy. - Module
kernels— registry of remote Agent OS cores, HTTP plane (kernel_health/models/agents/templates/request) and lifecycle over SSH (kernel_service/logs/deploy).