docs: clarify plugin agent tool config

This commit is contained in:
Peter Steinberger
2026-01-18 04:27:50 +00:00
parent efdb33c975
commit 331b8157b0
2 changed files with 14 additions and 3 deletions

View File

@@ -6,8 +6,13 @@ read_when:
---
# Plugin agent tools
Clawdbot plugins can register agent tools (JSONschema functions) that appear in the
agent tool list. Tools can be **required** (always available) or **optional** (optin).
Clawdbot plugins can register **agent tools** (JSONschema functions) that are exposed
to the LLM during agent runs. Tools can be **required** (always available) or
**optional** (optin).
Agent tools are configured under `tools` in the main config, or peragent under
`agents.list[].tools`. The allowlist/denylist policy controls which tools the agent
can call.
## Basic tool
@@ -55,7 +60,7 @@ export default function (api) {
}
```
Enable optional tools in `agents.list[].tools.allow`:
Enable optional tools in `agents.list[].tools.allow` (or global `tools.allow`):
```json5
{
@@ -76,6 +81,11 @@ Enable optional tools in `agents.list[].tools.allow`:
}
```
Other config knobs that affect tool availability:
- `tools.profile` / `agents.list[].tools.profile` (base allowlist)
- `tools.byProvider` / `agents.list[].tools.byProvider` (providerspecific allow/deny)
- `tools.sandbox.tools.*` (sandbox tool policy when sandboxed)
## Rules + tips
- Tool names must **not** clash with core tool names; conflicting tools are skipped.