入口点
- Gateway RPC:
agent和agent.wait。 - CLI:
agent命令。
工作原理(高层)
agentRPC 验证参数,解析 session(sessionKey/sessionId),持久化 session 元数据,并立即返回{ runId, acceptedAt }。agentCommand运行 agent:- 解析模型 + thinking/verbose/trace 默认值
- 加载 skills 快照
- 调用
runEmbeddedAgent(OpenClaw agent 运行时) - 如果嵌入式 loop 没有发出生命周期结束/错误事件,则发出 lifecycle end/error
runEmbeddedAgent:- 通过每个 session + 全局队列串行化运行
- 解析模型 + auth profile 并构建 OpenClaw session
- 订阅 runtime 事件并流式传输 assistant/tool 增量
- 强制执行超时 -> 超时后中止运行
- 对于 Codex app-server turn,如果已接受的 turn 在没有产生 app-server 进度且未到终态事件前停止,则中止该 turn
- 返回 payload 和 usage 元数据
subscribeEmbeddedAgentSession将 agent runtime 事件桥接到 OpenClawagent流:- tool 事件 =>
stream: "tool" - assistant deltas =>
stream: "assistant" - lifecycle 事件 =>
stream: "lifecycle"(phase: "start" | "end" | "error")
- tool 事件 =>
agent.wait使用waitForAgentRun:- 等待
runId的 lifecycle end/error - 返回
{ status: ok|error|timeout, startedAt, endedAt, error? }
- 等待
排队 + 并发
- 运行会按 session key(session lane)串行化,并且可选地通过全局 lane 进一步串行化。
- 这可以防止工具/session 竞争,并保持 session 历史一致。
- 消息通道可以选择队列模式(steer/followup/collect/interrupt),这些模式会进入该 lane 系统。 参见 Command Queue。
- transcript 写入也受 session 文件上的 session 写锁保护。该锁具有进程感知且基于文件,因此可以捕获绕过进程内队列或来自其他进程的写入者。session transcript 写入器最多等待
session.writeLock.acquireTimeoutMs之后才会将 session 报告为繁忙;默认值为60000ms。 - session 写锁默认不可重入。如果某个 helper 有意在保持单一逻辑写入者的同时嵌套获取同一把锁,则必须显式启用
allowReentrant: true。
Session + workspace 准备
- workspace 会被解析并创建;沙箱运行可能会重定向到沙箱 workspace 根目录。
- skills 会被加载(或复用快照)并注入到 env 和 prompt。
- bootstrap/context 文件会被解析并注入到 system prompt 报告中。
- 会获取 session write lock;在流式传输开始前,
SessionManager会被打开并准备好。任何后续的 transcript 重写、压缩或截断路径,在打开或修改 transcript 文件之前都必须获取同一把锁。
Prompt 组装 + system prompt
- 系统提示词基于 OpenClaw 的基础提示词、skills 提示词、bootstrap 上下文以及每次运行的覆盖项构建。
- 会强制执行模型相关限制和 compaction 预留 token。
- 参见 System prompt 了解模型能看到的内容。
Hook 点(你可以在这里拦截)
OpenClaw 有两套 hook 系统:- 内部 hooks(Gateway hooks):用于命令和生命周期事件的事件驱动脚本。
- 插件 hooks:agent/tool 生命周期和 gateway pipeline 内的扩展点。
内部 hooks(Gateway hooks)
agent:bootstrap:在构建 bootstrap 文件、system prompt 最终定稿之前运行。 可用于添加/移除 bootstrap 上下文文件。- 命令 hooks:
/new、/reset、/stop以及其他命令事件(见 Hooks 文档)。
插件 hooks(agent + gateway 生命周期)
这些 hook 在 agent loop 或 gateway pipeline 内部运行:before_model_resolve:在会话前运行(没有messages),用于在模型解析前确定性地覆盖 provider/model。before_prompt_build:在 session 加载后运行(带有messages),用于在提示提交前注入prependContext、systemPrompt、prependSystemContext或appendSystemContext。对每轮动态文本使用prependContext,对应放在 system prompt 空间中的稳定指引使用 system-context 字段。before_agent_start:兼容旧逻辑的 hook,可能在任一阶段运行;优先使用上面的显式 hooks。before_agent_reply:在内联动作之后、LLM 调用之前运行,让插件可以接管该轮并返回合成回复,或完全静默该轮。agent_end:在完成后检查最终消息列表和运行元数据。before_compaction/after_compaction:观察或标注 compaction 周期。before_tool_call/after_tool_call:拦截工具参数/结果。before_install:检查安装上下文,并在 operator install policy 运行后选择性阻止 skill 或 plugin 安装。tool_result_persist:在工具结果写入 OpenClaw 所拥有的 session transcript 之前,同步转换这些结果。message_received/message_sending/message_sent:入站 + 出站消息 hooks。session_start/session_end:session 生命周期边界。gateway_start/gateway_stop:gateway 生命周期事件。
before_tool_call:{ block: true }是终止性的,并停止低优先级处理器。before_tool_call:{ block: false }是无操作,不会清除之前的 block。before_install:{ block: true }是终止性的,并停止低优先级处理器。before_install:{ block: false }是无操作,不会清除之前的 block。message_sending:{ cancel: true }是终止性的,并停止低优先级处理器。message_sending:{ cancel: false }是无操作,不会清除之前的 cancel。
流式传输 + 部分回复
- Assistant 增量会从 agent runtime 流式输出,并作为
assistant事件发出。 - 块流式传输可以在
text_end或message_end时发出部分回复。 - Reasoning 流式传输可以作为单独的流或块回复发出。
- 参见 Streaming 了解分块和块回复行为。
工具执行 + 消息工具
- 工具 start/update/end 事件会在
toolstream 上发出。 - 工具结果在记录/发出前会针对大小和图像载荷进行清理。
- 会跟踪 messaging tool 的发送,以抑制重复的 assistant 确认。
回复整形 + 抑制
- 最终 payload 会由以下内容组装:
- assistant 文本(以及可选的 reasoning)
- 内联工具摘要(在 verbose 且允许时)
- 当模型出错时的 assistant 错误文本
- 精确的静默 token
NO_REPLY/no_reply会从出站 payload 中过滤掉。 - messaging tool 的重复内容会从最终 payload 列表中移除。
- 如果没有可渲染的 payload,且工具发生错误,则会发出一个兜底的工具错误回复 (除非某个 messaging tool 已经向用户发送了可见回复)。
压缩 + 重试
- 自动压缩会发出
compactionstream 事件,并且可能触发重试。 - 重试时,会重置内存缓冲区和工具摘要,以避免重复输出。
- 参见 Compaction 了解 compaction 流水线。
事件流(当前)
lifecycle:由subscribeEmbeddedAgentSession发出(并且作为后备由agentCommand发出)assistant:来自 agent runtime 的流式增量tool:来自 agent runtime 的流式工具事件
Chat 通道处理
- assistant 增量会被缓冲为 chat
delta消息。 - chat
final会在 生命周期结束/错误 时发出。
超时
agent.wait默认:30s(仅等待)。timeoutMs参数会覆盖此值。- Agent runtime:
agents.defaults.timeoutSeconds默认 172800s(48 小时);在runEmbeddedAgent的 abort 定时器中强制执行。 - Cron runtime:隔离的 agent-turn
timeoutSeconds由 cron 持有。调度器在执行开始时启动该计时器,在配置的截止时间中止底层运行,然后在记录超时之前执行有界清理,以免失控的子 session 将 lane 卡住。 - Session liveness diagnostics:启用 diagnostics 时,
diagnostics.stuckSessionWarnMs会将长时间processing且未观察到回复、工具、状态、块或 ACP 进度的 session 归类。活跃的嵌入式运行、模型调用和工具调用会报告为session.long_running;存在活跃工作但近期没有进度的会报告为session.stalled;session.stuck仅保留给可恢复的过期 session bookkeeping,包括带有过期无主模型/工具活动的空闲排队 session。恢复性 session bookkeeping 在恢复门槛通过后会立即释放受影响的 session lane;卡住的嵌入式运行只有在diagnostics.stuckSessionAbortMs之后才会进行 abort-drain(默认:至少 5 分钟且为警告阈值的 3 倍),这样排队工作可以继续而不会仅仅因为运行缓慢就被切断。恢复会发出结构化的 requested/completed 结果,并且仅当相同的 processing generation 仍然是当前值时,诊断状态才会标记为空闲。只要 session 未变化,重复的session.stuck诊断就会退避。 - Model idle timeout:OpenClaw 会在响应分片在空闲窗口到达前没有返回时中止模型请求。
models.providers.<id>.timeoutSeconds会为缓慢的本地/自托管 provider 延长这个空闲看门狗,但它仍然受任何更低的agents.defaults.timeoutSeconds或运行级超时约束,因为这些控制的是整个 agent 运行。否则 OpenClaw 在配置时使用agents.defaults.timeoutSeconds,默认上限为 120s。没有显式模型或 agent 超时的 cron 触发运行会禁用空闲看门狗,并依赖 cron 外层超时。 - Provider HTTP request timeout:
models.providers.<id>.timeoutSeconds适用于该 provider 的模型 HTTP fetch,包括连接、headers、body、SDK 请求超时、total guarded-fetch abort handling 和 model stream idle watchdog。对于慢速本地/自托管 provider(如 Ollama),应优先使用它,而不是提高整个 agent runtime 超时;当模型请求需要更长时间运行时,请确保 agent/runtime 超时至少同样高。
何时会更早结束
- Agent 超时(abort)
- AbortSignal(cancel)
- Gateway 断开连接或 RPC 超时
agent.wait超时(仅等待,不停止 agent)
相关内容
- Tools — 可用的 agent 工具
- Hooks — 由 agent 生命周期事件触发的事件驱动脚本
- Compaction — 如何对长对话进行摘要
- Exec Approvals — shell 命令的审批门禁
- Thinking — thinking/reasoning 级别配置