Pi 集成架构
本文档描述了 OpenClaw 如何与 pi-coding-agent 及其相关包(pi-ai、pi-agent-core、pi-tui)集成以实现其 AI 智能体能力。
概述
OpenClaw 使用 pi SDK 将 AI 编码智能体嵌入到其消息 Gateway 网关架构中。OpenClaw 不是将 pi 作为子进程生成或使用 RPC 模式,而是通过createAgentSession() 直接导入并实例化 pi 的 AgentSession。这种嵌入式方法提供了:
- 对会话生命周期和事件处理的完全控制
- 自定义工具注入(消息、沙箱、渠道特定操作)
- 每个渠道/上下文的系统提示自定义
- 支持分支/压缩的会话持久化
- 带故障转移的多账户认证配置文件轮换
- 与提供商无关的模型切换
包依赖
| 包 | 用途 |
|---|---|
pi-ai | 核心 LLM 抽象:Model、streamSimple、消息类型、提供商 API |
pi-agent-core | 智能体循环、工具执行、AgentMessage 类型 |
pi-coding-agent | 高级 SDK:createAgentSession、SessionManager、AuthStorage、ModelRegistry、内置工具 |
pi-tui | 终端 UI 组件(用于 OpenClaw 的本地 TUI 模式) |
文件结构
核心集成流程
1. 运行嵌入式智能体
主入口点是pi-embedded-runner/run.ts 中的 runEmbeddedPiAgent():
2. 会话创建
在runEmbeddedAttempt()(由 runEmbeddedPiAgent() 调用)内部,使用 pi SDK:
3. 事件订阅
subscribeEmbeddedPiSession() 订阅 pi 的 AgentSession 事件:
message_start/message_end/message_update(流式文本/思考)tool_execution_start/tool_execution_update/tool_execution_endturn_start/turn_endagent_start/agent_endauto_compaction_start/auto_compaction_end
4. 提示
设置完成后,会话被提示:工具架构
工具管道
- 基础工具:pi 的
codingTools(read、bash、edit、write) - 自定义替换:OpenClaw 将 bash 替换为
exec/process,为沙箱自定义 read/edit/write - OpenClaw 工具:消息、浏览器、画布、会话、定时任务、Gateway 网关等
- 渠道工具:Discord/Telegram/Slack/WhatsApp 特定的操作工具
- 策略过滤:工具按配置文件、提供商、智能体、群组、沙箱策略过滤
- Schema 规范化:为 Gemini/OpenAI 的特殊情况清理 Schema
- AbortSignal 包装:工具被包装以尊重中止信号
工具定义适配器
pi-agent-core 的AgentTool 与 pi-coding-agent 的 ToolDefinition 有不同的 execute 签名。pi-tool-definition-adapter.ts 中的适配器桥接了这一点:
工具拆分策略
splitSdkTools() 通过 customTools 传递所有工具:
系统提示构建
系统提示在buildAgentSystemPrompt()(system-prompt.ts)中构建。它组装一个完整的提示,包含工具、工具调用风格、安全护栏、OpenClaw CLI 参考、Skills、文档、工作区、沙箱、消息、回复标签、语音、静默回复、心跳、运行时元数据等部分,以及启用时的记忆和反应,还有可选的上下文文件和额外系统提示内容。部分内容在子智能体使用的最小提示模式下会被裁剪。
提示在会话创建后通过 applySystemPromptOverrideToSession() 应用:
会话管理
会话文件
会话是具有树结构(id/parentId 链接)的 JSONL 文件。Pi 的SessionManager 处理持久化:
guardSessionManager() 包装它以确保工具结果安全。
会话缓存
session-manager-cache.ts 缓存 SessionManager 实例以避免重复的文件解析:
历史限制
limitHistoryTurns() 根据渠道类型(私信 vs 群组)裁剪对话历史。
压缩
自动压缩在上下文溢出时触发。compactEmbeddedPiSessionDirect() 处理手动压缩:
认证与模型解析
认证配置文件
OpenClaw 维护一个认证配置文件存储,每个提供商有多个 API 密钥:模型解析
故障转移
FailoverError 在配置了回退时触发模型回退:
Pi 扩展
OpenClaw 加载自定义 pi 扩展以实现特殊行为:压缩安全护栏
pi-extensions/compaction-safeguard.ts 为压缩添加护栏,包括自适应令牌预算以及工具失败和文件操作摘要:
上下文裁剪
pi-extensions/context-pruning.ts 实现基于缓存 TTL 的上下文裁剪:
流式传输与块回复
块分块
EmbeddedBlockChunker 管理将流式文本分成离散的回复块:
思考/最终标签剥离
流式输出被处理以剥离<think>/<thinking> 块并提取 <final> 内容:
回复指令
回复指令如[[media:url]]、[[voice]]、[[reply:id]] 被解析和提取:
错误处理
错误分类
pi-embedded-helpers.ts 对错误进行分类以进行适当处理:
思考级别回退
如果思考级别不受支持,它会回退:沙箱集成
当启用沙箱模式时,工具和路径受到约束:提供商特定处理
Anthropic
- 拒绝魔术字符串清除
- 连续角色的回合验证
- Claude Code 参数兼容性
Google/Gemini
- 回合排序修复(
applyGoogleTurnOrderingFix) - 工具 schema 清理(
sanitizeToolsForGoogle) - 会话历史清理(
sanitizeSessionHistory)
OpenAI
- Codex 模型的
apply_patch工具 - 思考级别降级处理
TUI 集成
OpenClaw 还有一个本地 TUI 模式,直接使用 pi-tui 组件:与 Pi CLI 的主要区别
| 方面 | Pi CLI | OpenClaw 嵌入式 |
|---|---|---|
| 调用方式 | pi 命令 / RPC | 通过 createAgentSession() 的 SDK |
| 工具 | 默认编码工具 | 自定义 OpenClaw 工具套件 |
| 系统提示 | AGENTS.md + prompts | 按渠道/上下文动态生成 |
| 会话存储 | ~/.pi/agent/sessions/ | ~/.openclaw/agents/<agentId>/sessions/(或 $OPENCLAW_STATE_DIR/agents/<agentId>/sessions/) |
| 认证 | 单一凭证 | 带轮换的多配置文件 |
| 扩展 | 从磁盘加载 | 编程方式 + 磁盘路径 |
| 事件处理 | TUI 渲染 | 基于回调(onBlockReply 等) |
未来考虑
可能需要重构的领域:- 工具签名对齐:目前在 pi-agent-core 和 pi-coding-agent 签名之间适配
- 会话管理器包装:
guardSessionManager增加了安全性但增加了复杂性 - 扩展加载:可以更直接地使用 pi 的
ResourceLoader - 流式处理器复杂性:
subscribeEmbeddedPiSession已经变得很大 - 提供商特殊情况:许多提供商特定的代码路径,pi 可能可以处理
测试
所有涵盖 pi 集成及其扩展的现有测试:src/agents/pi-embedded-block-chunker.test.tssrc/agents/pi-embedded-helpers.buildbootstrapcontextfiles.test.tssrc/agents/pi-embedded-helpers.classifyfailoverreason.test.tssrc/agents/pi-embedded-helpers.downgradeopenai-reasoning.test.tssrc/agents/pi-embedded-helpers.formatassistanterrortext.test.tssrc/agents/pi-embedded-helpers.formatrawassistanterrorforui.test.tssrc/agents/pi-embedded-helpers.image-dimension-error.test.tssrc/agents/pi-embedded-helpers.image-size-error.test.tssrc/agents/pi-embedded-helpers.isautherrormessage.test.tssrc/agents/pi-embedded-helpers.isbillingerrormessage.test.tssrc/agents/pi-embedded-helpers.iscloudcodeassistformaterror.test.tssrc/agents/pi-embedded-helpers.iscompactionfailureerror.test.tssrc/agents/pi-embedded-helpers.iscontextoverflowerror.test.tssrc/agents/pi-embedded-helpers.isfailovererrormessage.test.tssrc/agents/pi-embedded-helpers.islikelycontextoverflowerror.test.tssrc/agents/pi-embedded-helpers.ismessagingtoolduplicate.test.tssrc/agents/pi-embedded-helpers.messaging-duplicate.test.tssrc/agents/pi-embedded-helpers.normalizetextforcomparison.test.tssrc/agents/pi-embedded-helpers.resolvebootstrapmaxchars.test.tssrc/agents/pi-embedded-helpers.sanitize-session-messages-images.keeps-tool-call-tool-result-ids-unchanged.test.tssrc/agents/pi-embedded-helpers.sanitize-session-messages-images.removes-empty-assistant-text-blocks-but-preserves.test.tssrc/agents/pi-embedded-helpers.sanitizegoogleturnordering.test.tssrc/agents/pi-embedded-helpers.sanitizesessionmessagesimages-thought-signature-stripping.test.tssrc/agents/pi-embedded-helpers.sanitizetoolcallid.test.tssrc/agents/pi-embedded-helpers.sanitizeuserfacingtext.test.tssrc/agents/pi-embedded-helpers.stripthoughtsignatures.test.tssrc/agents/pi-embedded-helpers.validate-turns.test.tssrc/agents/pi-embedded-runner-extraparams.live.test.ts(实时)src/agents/pi-embedded-runner-extraparams.test.tssrc/agents/pi-embedded-runner.applygoogleturnorderingfix.test.tssrc/agents/pi-embedded-runner.buildembeddedsandboxinfo.test.tssrc/agents/pi-embedded-runner.createsystempromptoverride.test.tssrc/agents/pi-embedded-runner.get-dm-history-limit-from-session-key.falls-back-provider-default-per-dm-not.test.tssrc/agents/pi-embedded-runner.get-dm-history-limit-from-session-key.returns-undefined-sessionkey-is-undefined.test.tssrc/agents/pi-embedded-runner.google-sanitize-thinking.test.tssrc/agents/pi-embedded-runner.guard.test.tssrc/agents/pi-embedded-runner.limithistoryturns.test.tssrc/agents/pi-embedded-runner.resolvesessionagentids.test.tssrc/agents/pi-embedded-runner.run-embedded-pi-agent.auth-profile-rotation.test.tssrc/agents/pi-embedded-runner.sanitize-session-history.test.tssrc/agents/pi-embedded-runner.splitsdktools.test.tssrc/agents/pi-embedded-runner.test.tssrc/agents/pi-embedded-subscribe.code-span-awareness.test.tssrc/agents/pi-embedded-subscribe.reply-tags.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.calls-onblockreplyflush-before-tool-execution-start-preserve.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-append-text-end-content-is.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-call-onblockreplyflush-callback-is-not.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-duplicate-text-end-repeats-full.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-emit-duplicate-block-replies-text.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.emits-block-replies-text-end-does-not.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.emits-reasoning-as-separate-message-enabled.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.filters-final-suppresses-output-without-start-tag.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.includes-canvas-action-metadata-tool-summaries.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.keeps-assistanttexts-final-answer-block-replies-are.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.keeps-indented-fenced-blocks-intact.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.reopens-fenced-blocks-splitting-inside-them.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.splits-long-single-line-fenced-blocks-reopen.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.streams-soft-chunks-paragraph-preference.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.subscribeembeddedpisession.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.suppresses-message-end-block-replies-message-tool.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.waits-multiple-compaction-retries-before-resolving.test.tssrc/agents/pi-embedded-subscribe.tools.test.tssrc/agents/pi-embedded-utils.test.tssrc/agents/pi-extensions/compaction-safeguard.test.tssrc/agents/pi-extensions/context-pruning.test.tssrc/agents/pi-settings.test.tssrc/agents/pi-tool-definition-adapter.test.tssrc/agents/pi-tools-agent-config.test.tssrc/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping-b.test.tssrc/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping-d.test.tssrc/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping-f.test.tssrc/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping.test.tssrc/agents/pi-tools.policy.test.tssrc/agents/pi-tools.safe-bins.test.tssrc/agents/pi-tools.workspace-paths.test.ts