mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-20 14:30:57 +00:00
67da67b61a
* docs: fix A-Z built-in tools nav, split plugin page, consolidate sandbox docs * docs: add dedicated OpenShell sandbox backend page * style: format markdown tables * docs: trim plugin page, restructure available plugins into table + categories
365 lines
9.2 KiB
Markdown
365 lines
9.2 KiB
Markdown
---
|
|
summary: “Per-agent sandbox + tool restrictions, precedence, and examples”
|
|
title: Multi-Agent Sandbox & Tools
|
|
read_when: “You want per-agent sandboxing or per-agent tool allow/deny policies in a multi-agent gateway.”
|
|
status: active
|
|
---
|
|
|
|
# Multi-Agent Sandbox & Tools Configuration
|
|
|
|
Each agent in a multi-agent setup can override the global sandbox and tool
|
|
policy. This page covers per-agent configuration, precedence rules, and
|
|
examples.
|
|
|
|
- **Sandbox backends and modes**: see [Sandboxing](/gateway/sandboxing).
|
|
- **Debugging blocked tools**: see [Sandbox vs Tool Policy vs Elevated](/gateway/sandbox-vs-tool-policy-vs-elevated) and `openclaw sandbox explain`.
|
|
- **Elevated exec**: see [Elevated Mode](/tools/elevated).
|
|
|
|
Auth is per-agent: each agent reads from its own `agentDir` auth store at
|
|
`~/.openclaw/agents/<agentId>/agent/auth-profiles.json`.
|
|
Credentials are **not** shared between agents. Never reuse `agentDir` across agents.
|
|
If you want to share creds, copy `auth-profiles.json` into the other agent's `agentDir`.
|
|
|
|
---
|
|
|
|
## Configuration Examples
|
|
|
|
### Example 1: Personal + Restricted Family Agent
|
|
|
|
```json
|
|
{
|
|
"agents": {
|
|
"list": [
|
|
{
|
|
"id": "main",
|
|
"default": true,
|
|
"name": "Personal Assistant",
|
|
"workspace": "~/.openclaw/workspace",
|
|
"sandbox": { "mode": "off" }
|
|
},
|
|
{
|
|
"id": "family",
|
|
"name": "Family Bot",
|
|
"workspace": "~/.openclaw/workspace-family",
|
|
"sandbox": {
|
|
"mode": "all",
|
|
"scope": "agent"
|
|
},
|
|
"tools": {
|
|
"allow": ["read"],
|
|
"deny": ["exec", "write", "edit", "apply_patch", "process", "browser"]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"bindings": [
|
|
{
|
|
"agentId": "family",
|
|
"match": {
|
|
"provider": "whatsapp",
|
|
"accountId": "*",
|
|
"peer": {
|
|
"kind": "group",
|
|
"id": "120363424282127706@g.us"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
**Result:**
|
|
|
|
- `main` agent: Runs on host, full tool access
|
|
- `family` agent: Runs in Docker (one container per agent), only `read` tool
|
|
|
|
---
|
|
|
|
### Example 2: Work Agent with Shared Sandbox
|
|
|
|
```json
|
|
{
|
|
"agents": {
|
|
"list": [
|
|
{
|
|
"id": "personal",
|
|
"workspace": "~/.openclaw/workspace-personal",
|
|
"sandbox": { "mode": "off" }
|
|
},
|
|
{
|
|
"id": "work",
|
|
"workspace": "~/.openclaw/workspace-work",
|
|
"sandbox": {
|
|
"mode": "all",
|
|
"scope": "shared",
|
|
"workspaceRoot": "/tmp/work-sandboxes"
|
|
},
|
|
"tools": {
|
|
"allow": ["read", "write", "apply_patch", "exec"],
|
|
"deny": ["browser", "gateway", "discord"]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
### Example 2b: Global coding profile + messaging-only agent
|
|
|
|
```json
|
|
{
|
|
"tools": { "profile": "coding" },
|
|
"agents": {
|
|
"list": [
|
|
{
|
|
"id": "support",
|
|
"tools": { "profile": "messaging", "allow": ["slack"] }
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
**Result:**
|
|
|
|
- default agents get coding tools
|
|
- `support` agent is messaging-only (+ Slack tool)
|
|
|
|
---
|
|
|
|
### Example 3: Different Sandbox Modes per Agent
|
|
|
|
```json
|
|
{
|
|
"agents": {
|
|
"defaults": {
|
|
"sandbox": {
|
|
"mode": "non-main", // Global default
|
|
"scope": "session"
|
|
}
|
|
},
|
|
"list": [
|
|
{
|
|
"id": "main",
|
|
"workspace": "~/.openclaw/workspace",
|
|
"sandbox": {
|
|
"mode": "off" // Override: main never sandboxed
|
|
}
|
|
},
|
|
{
|
|
"id": "public",
|
|
"workspace": "~/.openclaw/workspace-public",
|
|
"sandbox": {
|
|
"mode": "all", // Override: public always sandboxed
|
|
"scope": "agent"
|
|
},
|
|
"tools": {
|
|
"allow": ["read"],
|
|
"deny": ["exec", "write", "edit", "apply_patch"]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Configuration Precedence
|
|
|
|
When both global (`agents.defaults.*`) and agent-specific (`agents.list[].*`) configs exist:
|
|
|
|
### Sandbox Config
|
|
|
|
Agent-specific settings override global:
|
|
|
|
```
|
|
agents.list[].sandbox.mode > agents.defaults.sandbox.mode
|
|
agents.list[].sandbox.scope > agents.defaults.sandbox.scope
|
|
agents.list[].sandbox.workspaceRoot > agents.defaults.sandbox.workspaceRoot
|
|
agents.list[].sandbox.workspaceAccess > agents.defaults.sandbox.workspaceAccess
|
|
agents.list[].sandbox.docker.* > agents.defaults.sandbox.docker.*
|
|
agents.list[].sandbox.browser.* > agents.defaults.sandbox.browser.*
|
|
agents.list[].sandbox.prune.* > agents.defaults.sandbox.prune.*
|
|
```
|
|
|
|
**Notes:**
|
|
|
|
- `agents.list[].sandbox.{docker,browser,prune}.*` overrides `agents.defaults.sandbox.{docker,browser,prune}.*` for that agent (ignored when sandbox scope resolves to `"shared"`).
|
|
|
|
### Tool Restrictions
|
|
|
|
The filtering order is:
|
|
|
|
1. **Tool profile** (`tools.profile` or `agents.list[].tools.profile`)
|
|
2. **Provider tool profile** (`tools.byProvider[provider].profile` or `agents.list[].tools.byProvider[provider].profile`)
|
|
3. **Global tool policy** (`tools.allow` / `tools.deny`)
|
|
4. **Provider tool policy** (`tools.byProvider[provider].allow/deny`)
|
|
5. **Agent-specific tool policy** (`agents.list[].tools.allow/deny`)
|
|
6. **Agent provider policy** (`agents.list[].tools.byProvider[provider].allow/deny`)
|
|
7. **Sandbox tool policy** (`tools.sandbox.tools` or `agents.list[].tools.sandbox.tools`)
|
|
8. **Subagent tool policy** (`tools.subagents.tools`, if applicable)
|
|
|
|
Each level can further restrict tools, but cannot grant back denied tools from earlier levels.
|
|
If `agents.list[].tools.sandbox.tools` is set, it replaces `tools.sandbox.tools` for that agent.
|
|
If `agents.list[].tools.profile` is set, it overrides `tools.profile` for that agent.
|
|
Provider tool keys accept either `provider` (e.g. `google-antigravity`) or `provider/model` (e.g. `openai/gpt-5.2`).
|
|
|
|
Tool policies support `group:*` shorthands that expand to multiple tools. See [Tool groups](/gateway/sandbox-vs-tool-policy-vs-elevated#tool-groups-shorthands) for the full list.
|
|
|
|
Per-agent elevated overrides (`agents.list[].tools.elevated`) can further restrict elevated exec for specific agents. See [Elevated Mode](/tools/elevated) for details.
|
|
|
|
---
|
|
|
|
## Migration from Single Agent
|
|
|
|
**Before (single agent):**
|
|
|
|
```json
|
|
{
|
|
"agents": {
|
|
"defaults": {
|
|
"workspace": "~/.openclaw/workspace",
|
|
"sandbox": {
|
|
"mode": "non-main"
|
|
}
|
|
}
|
|
},
|
|
"tools": {
|
|
"sandbox": {
|
|
"tools": {
|
|
"allow": ["read", "write", "apply_patch", "exec"],
|
|
"deny": []
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
**After (multi-agent with different profiles):**
|
|
|
|
```json
|
|
{
|
|
"agents": {
|
|
"list": [
|
|
{
|
|
"id": "main",
|
|
"default": true,
|
|
"workspace": "~/.openclaw/workspace",
|
|
"sandbox": { "mode": "off" }
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
Legacy `agent.*` configs are migrated by `openclaw doctor`; prefer `agents.defaults` + `agents.list` going forward.
|
|
|
|
---
|
|
|
|
## Tool Restriction Examples
|
|
|
|
### Read-only Agent
|
|
|
|
```json
|
|
{
|
|
"tools": {
|
|
"allow": ["read"],
|
|
"deny": ["exec", "write", "edit", "apply_patch", "process"]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Safe Execution Agent (no file modifications)
|
|
|
|
```json
|
|
{
|
|
"tools": {
|
|
"allow": ["read", "exec", "process"],
|
|
"deny": ["write", "edit", "apply_patch", "browser", "gateway"]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Communication-only Agent
|
|
|
|
```json
|
|
{
|
|
"tools": {
|
|
"sessions": { "visibility": "tree" },
|
|
"allow": ["sessions_list", "sessions_send", "sessions_history", "session_status"],
|
|
"deny": ["exec", "write", "edit", "apply_patch", "read", "browser"]
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Common Pitfall: "non-main"
|
|
|
|
`agents.defaults.sandbox.mode: "non-main"` is based on `session.mainKey` (default `"main"`),
|
|
not the agent id. Group/channel sessions always get their own keys, so they
|
|
are treated as non-main and will be sandboxed. If you want an agent to never
|
|
sandbox, set `agents.list[].sandbox.mode: "off"`.
|
|
|
|
---
|
|
|
|
## Testing
|
|
|
|
After configuring multi-agent sandbox and tools:
|
|
|
|
1. **Check agent resolution:**
|
|
|
|
```exec
|
|
openclaw agents list --bindings
|
|
```
|
|
|
|
2. **Verify sandbox containers:**
|
|
|
|
```exec
|
|
docker ps --filter "name=openclaw-sbx-"
|
|
```
|
|
|
|
3. **Test tool restrictions:**
|
|
- Send a message requiring restricted tools
|
|
- Verify the agent cannot use denied tools
|
|
|
|
4. **Monitor logs:**
|
|
|
|
```exec
|
|
tail -f "${OPENCLAW_STATE_DIR:-$HOME/.openclaw}/logs/gateway.log" | grep -E "routing|sandbox|tools"
|
|
```
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### Agent not sandboxed despite `mode: "all"`
|
|
|
|
- Check if there's a global `agents.defaults.sandbox.mode` that overrides it
|
|
- Agent-specific config takes precedence, so set `agents.list[].sandbox.mode: "all"`
|
|
|
|
### Tools still available despite deny list
|
|
|
|
- Check tool filtering order: global → agent → sandbox → subagent
|
|
- Each level can only further restrict, not grant back
|
|
- Verify with logs: `[tools] filtering tools for agent:${agentId}`
|
|
|
|
### Container not isolated per agent
|
|
|
|
- Set `scope: "agent"` in agent-specific sandbox config
|
|
- Default is `"session"` which creates one container per session
|
|
|
|
---
|
|
|
|
## See also
|
|
|
|
- [Sandboxing](/gateway/sandboxing) -- full sandbox reference (modes, scopes, backends, images)
|
|
- [Sandbox vs Tool Policy vs Elevated](/gateway/sandbox-vs-tool-policy-vs-elevated) -- debugging "why is this blocked?"
|
|
- [Elevated Mode](/tools/elevated)
|
|
- [Multi-Agent Routing](/concepts/multi-agent)
|
|
- [Sandbox Configuration](/gateway/configuration#agentsdefaults-sandbox)
|
|
- [Session Management](/concepts/session)
|