* Subagents: restore announce flow and fix nested delivery retries * fix: prep subagent announce + docs alignment (#22223) (thanks @tyler6204)
10 KiB
summary, read_when, title
| summary | read_when | title | ||
|---|---|---|---|---|
| Sub-agents: spawning isolated agent runs that announce results back to the requester chat |
|
Sub-Agents |
Sub-agents
Sub-agents are background agent runs spawned from an existing agent run. They run in their own session (agent:<agentId>:subagent:<uuid>) and, when finished, announce their result back to the requester chat channel.
Slash command
Use /subagents to inspect or control sub-agent runs for the current session:
/subagents list/subagents kill <id|#|all>/subagents log <id|#> [limit] [tools]/subagents info <id|#>/subagents send <id|#> <message>/subagents steer <id|#> <message>/subagents spawn <agentId> <task> [--model <model>] [--thinking <level>]
/subagents info shows run metadata (status, timestamps, session id, transcript path, cleanup).
Spawn behavior
/subagents spawn starts a background sub-agent as a user command, not an internal relay, and it sends one final completion update back to the requester chat when the run finishes.
- The spawn command is non-blocking; it returns a run id immediately.
- On completion, the sub-agent announces a summary/result message back to the requester chat channel.
- For manual spawns, delivery is resilient:
- OpenClaw tries direct
agentdelivery first with a stable idempotency key. - If direct delivery fails, it falls back to queue routing.
- If queue routing is still not available, the announce is retried with a short exponential backoff before final give-up.
- OpenClaw tries direct
- The completion message is a system message and includes:
Result(latest assistant reply text from the child session, after a short settle retry)Status(completed successfully/failed/timed out)- compact runtime/token stats
--modeland--thinkingoverride defaults for that specific run.- Use
info/logto inspect details and output after completion.
Primary goals:
- Parallelize "research / long task / slow tool" work without blocking the main run.
- Keep sub-agents isolated by default (session separation + optional sandboxing).
- Keep the tool surface hard to misuse: sub-agents do not get session tools by default.
- Support configurable nesting depth for orchestrator patterns.
Cost note: each sub-agent has its own context and token usage. For heavy or repetitive
tasks, set a cheaper model for sub-agents and keep your main agent on a higher-quality model.
You can configure this via agents.defaults.subagents.model or per-agent overrides.
Tool
Use sessions_spawn:
- Starts a sub-agent run (
deliver: false, global lane:subagent) - Then runs an announce step and posts the announce reply to the requester chat channel
- Default model: inherits the caller unless you set
agents.defaults.subagents.model(or per-agentagents.list[].subagents.model); an explicitsessions_spawn.modelstill wins. - Default thinking: inherits the caller unless you set
agents.defaults.subagents.thinking(or per-agentagents.list[].subagents.thinking); an explicitsessions_spawn.thinkingstill wins.
Tool params:
task(required)label?(optional)agentId?(optional; spawn under another agent id if allowed)model?(optional; overrides the sub-agent model; invalid values are skipped and the sub-agent runs on the default model with a warning in the tool result)thinking?(optional; overrides thinking level for the sub-agent run)runTimeoutSeconds?(default0; when set, the sub-agent run is aborted after N seconds)cleanup?(delete|keep, defaultkeep)
Allowlist:
agents.list[].subagents.allowAgents: list of agent ids that can be targeted viaagentId(["*"]to allow any). Default: only the requester agent.
Discovery:
- Use
agents_listto see which agent ids are currently allowed forsessions_spawn.
Auto-archive:
- Sub-agent sessions are automatically archived after
agents.defaults.subagents.archiveAfterMinutes(default: 60). - Archive uses
sessions.deleteand renames the transcript to*.deleted.<timestamp>(same folder). cleanup: "delete"archives immediately after announce (still keeps the transcript via rename).- Auto-archive is best-effort; pending timers are lost if the gateway restarts.
runTimeoutSecondsdoes not auto-archive; it only stops the run. The session remains until auto-archive.- Auto-archive applies equally to depth-1 and depth-2 sessions.
Nested Sub-Agents
By default, sub-agents can spawn one additional level (maxSpawnDepth: 2), enabling the orchestrator pattern: main → orchestrator sub-agent → worker sub-sub-agents. Set maxSpawnDepth: 1 to disable nested spawning.
How to enable
{
agents: {
defaults: {
subagents: {
maxSpawnDepth: 2, // allow sub-agents to spawn children (default: 2)
maxChildrenPerAgent: 5, // max active children per agent session (default: 5)
maxConcurrent: 8, // global concurrency lane cap (default: 8)
},
},
},
}
Depth levels
| Depth | Session key shape | Role | Can spawn? |
|---|---|---|---|
| 0 | agent:<id>:main |
Main agent | Always |
| 1 | agent:<id>:subagent:<uuid> |
Sub-agent (orchestrator by default) | Yes, when maxSpawnDepth >= 2 |
| 2 | agent:<id>:subagent:<uuid>:subagent:<uuid> |
Sub-sub-agent (leaf worker) | No, when maxSpawnDepth = 2 |
Announce chain
Results flow back up the chain:
- Depth-2 worker finishes → announces to its parent (depth-1 orchestrator)
- Depth-1 orchestrator receives the announce, synthesizes results, finishes → announces to main
- Main agent receives the announce and delivers to the user
Each level only sees announces from its direct children.
Tool policy by depth
- Depth 1 (orchestrator, default with
maxSpawnDepth = 2): Getssessions_spawn,subagents,sessions_list,sessions_historyso it can manage its children. Other session/system tools remain denied. - Depth 1 (leaf, when
maxSpawnDepth = 1): No session tools. - Depth 2 (leaf worker, default
maxSpawnDepth = 2): No session tools,sessions_spawnis denied at depth 2, cannot spawn further children.
Per-agent spawn limit
Each agent session (at any depth) can have at most maxChildrenPerAgent (default: 5) active children at a time. This prevents runaway fan-out from a single orchestrator.
Cascade stop
Stopping a depth-1 orchestrator automatically stops all its depth-2 children:
/stopin the main chat stops all depth-1 agents and cascades to their depth-2 children./subagents kill <id>stops a specific sub-agent and cascades to its children./subagents kill allstops all sub-agents for the requester and cascades.
Authentication
Sub-agent auth is resolved by agent id, not by session type:
- The sub-agent session key is
agent:<agentId>:subagent:<uuid>. - The auth store is loaded from that agent's
agentDir. - The main agent's auth profiles are merged in as a fallback; agent profiles override main profiles on conflicts.
Note: the merge is additive, so main profiles are always available as fallbacks. Fully isolated auth per agent is not supported yet.
Announce
Sub-agents report back via an announce injection step:
- OpenClaw reads the child session's latest assistant reply after completion, with a short settle retry.
- It builds a system message with
Status,Result, compact stats, and reply guidance. - The message is injected with a follow-up
agentcall:deliver=falsewhen the requester is another sub-agent, this keeps orchestration internal.deliver=truewhen the requester is main, this produces the user-facing update.
- Delivery context prefers captured requester origin, but non-deliverable channels (for example
webchat) are ignored in favor of persisted deliverable routes. - Recipient agents can return the internal silent token to suppress duplicate outward delivery in the same turn.
Statusis derived from runtime outcome signals, not inferred from model output.
Announce payloads include a stats line at the end (even when wrapped):
- Runtime (e.g.,
runtime 5m12s) - Token usage (input/output/total)
- Estimated cost when model pricing is configured (
models.providers.*.models[].cost) sessionKey,sessionId, and transcript path (so the main agent can fetch history viasessions_historyor inspect the file on disk)
Tool Policy (sub-agent tools)
By default, sub-agents get all tools except session tools and system tools:
sessions_listsessions_historysessions_sendsessions_spawn
With the default maxSpawnDepth = 2, depth-1 orchestrator sub-agents receive sessions_spawn, subagents, sessions_list, and sessions_history so they can manage their children. If you set maxSpawnDepth = 1, those session tools stay denied.
Override via config:
{
agents: {
defaults: {
subagents: {
maxConcurrent: 1,
},
},
},
tools: {
subagents: {
tools: {
// deny wins
deny: ["gateway", "cron"],
// if allow is set, it becomes allow-only (deny still wins)
// allow: ["read", "exec", "process"]
},
},
},
}
Concurrency
Sub-agents use a dedicated in-process queue lane:
- Lane name:
subagent - Concurrency:
agents.defaults.subagents.maxConcurrent(default8)
Stopping
- Sending
/stopin the requester chat aborts the requester session and stops any active sub-agent runs spawned from it, cascading to nested children. /subagents kill <id>stops a specific sub-agent and cascades to its children.
Limitations
- Sub-agent announce is best-effort. If the gateway restarts, pending "announce back" work is lost.
- Sub-agents still share the same gateway process resources; treat
maxConcurrentas a safety valve. sessions_spawnis always non-blocking: it returns{ status: "accepted", runId, childSessionKey }immediately.- Sub-agent context only injects
AGENTS.md+TOOLS.md(noSOUL.md,IDENTITY.md,USER.md,HEARTBEAT.md, orBOOTSTRAP.md). - Maximum nesting depth is 5 (
maxSpawnDepthrange: 1–5). Depth 2 is recommended for most use cases. maxChildrenPerAgentcaps active children per session (default: 5, range: 1–20).