跳转到主要内容

Pi 集成架构

本文档描述了 OpenClaw 如何与 pi-coding-agent 及其相关包(pi-aipi-agent-corepi-tui)集成以实现其 AI 智能体能力。

概述

OpenClaw 使用 pi SDK 将 AI 编码智能体嵌入到其消息 Gateway 网关架构中。OpenClaw 不是将 pi 作为子进程生成或使用 RPC 模式,而是通过 createAgentSession() 直接导入并实例化 pi 的 AgentSession。这种嵌入式方法提供了:
  • 对会话生命周期和事件处理的完全控制
  • 自定义工具注入(消息、沙箱、渠道特定操作)
  • 每个渠道/上下文的系统提示自定义
  • 支持分支/压缩的会话持久化
  • 带故障转移的多账户认证配置文件轮换
  • 与提供商无关的模型切换

包依赖

文件结构

核心集成流程

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_end
  • turn_start / turn_end
  • agent_start / agent_end
  • auto_compaction_start / auto_compaction_end

4. 提示

设置完成后,会话被提示:
SDK 处理完整的智能体循环:发送到 LLM、执行工具调用、流式响应。

工具架构

工具管道

  1. 基础工具:pi 的 codingTools(read、bash、edit、write)
  2. 自定义替换:OpenClaw 将 bash 替换为 exec/process,为沙箱自定义 read/edit/write
  3. OpenClaw 工具:消息、浏览器、画布、会话、定时任务、Gateway 网关等
  4. 渠道工具:Discord/Telegram/Slack/WhatsApp 特定的操作工具
  5. 策略过滤:工具按配置文件、提供商、智能体、群组、沙箱策略过滤
  6. Schema 规范化:为 Gemini/OpenAI 的特殊情况清理 Schema
  7. AbortSignal 包装:工具被包装以尊重中止信号

工具定义适配器

pi-agent-core 的 AgentTool 与 pi-coding-agent 的 ToolDefinition 有不同的 execute 签名。pi-tool-definition-adapter.ts 中的适配器桥接了这一点:

工具拆分策略

splitSdkTools() 通过 customTools 传递所有工具:
这确保 OpenClaw 的策略过滤、沙箱集成和扩展工具集在各提供商之间保持一致。

系统提示构建

系统提示在 buildAgentSystemPrompt()system-prompt.ts)中构建。它组装一个完整的提示,包含工具、工具调用风格、安全护栏、OpenClaw CLI 参考、Skills、文档、工作区、沙箱、消息、回复标签、语音、静默回复、心跳、运行时元数据等部分,以及启用时的记忆和反应,还有可选的上下文文件和额外系统提示内容。部分内容在子智能体使用的最小提示模式下会被裁剪。 提示在会话创建后通过 applySystemPromptOverrideToSession() 应用:

会话管理

会话文件

会话是具有树结构(id/parentId 链接)的 JSONL 文件。Pi 的 SessionManager 处理持久化:
OpenClaw 用 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 原生模式类似的交互式终端体验。

与 Pi CLI 的主要区别

未来考虑

可能需要重构的领域:
  1. 工具签名对齐:目前在 pi-agent-core 和 pi-coding-agent 签名之间适配
  2. 会话管理器包装guardSessionManager 增加了安全性但增加了复杂性
  3. 扩展加载:可以更直接地使用 pi 的 ResourceLoader
  4. 流式处理器复杂性subscribeEmbeddedPiSession 已经变得很大
  5. 提供商特殊情况:许多提供商特定的代码路径,pi 可能可以处理

测试

所有涵盖 pi 集成及其扩展的现有测试:
  • src/agents/pi-embedded-block-chunker.test.ts
  • src/agents/pi-embedded-helpers.buildbootstrapcontextfiles.test.ts
  • src/agents/pi-embedded-helpers.classifyfailoverreason.test.ts
  • src/agents/pi-embedded-helpers.downgradeopenai-reasoning.test.ts
  • src/agents/pi-embedded-helpers.formatassistanterrortext.test.ts
  • src/agents/pi-embedded-helpers.formatrawassistanterrorforui.test.ts
  • src/agents/pi-embedded-helpers.image-dimension-error.test.ts
  • src/agents/pi-embedded-helpers.image-size-error.test.ts
  • src/agents/pi-embedded-helpers.isautherrormessage.test.ts
  • src/agents/pi-embedded-helpers.isbillingerrormessage.test.ts
  • src/agents/pi-embedded-helpers.iscloudcodeassistformaterror.test.ts
  • src/agents/pi-embedded-helpers.iscompactionfailureerror.test.ts
  • src/agents/pi-embedded-helpers.iscontextoverflowerror.test.ts
  • src/agents/pi-embedded-helpers.isfailovererrormessage.test.ts
  • src/agents/pi-embedded-helpers.islikelycontextoverflowerror.test.ts
  • src/agents/pi-embedded-helpers.ismessagingtoolduplicate.test.ts
  • src/agents/pi-embedded-helpers.messaging-duplicate.test.ts
  • src/agents/pi-embedded-helpers.normalizetextforcomparison.test.ts
  • src/agents/pi-embedded-helpers.resolvebootstrapmaxchars.test.ts
  • src/agents/pi-embedded-helpers.sanitize-session-messages-images.keeps-tool-call-tool-result-ids-unchanged.test.ts
  • src/agents/pi-embedded-helpers.sanitize-session-messages-images.removes-empty-assistant-text-blocks-but-preserves.test.ts
  • src/agents/pi-embedded-helpers.sanitizegoogleturnordering.test.ts
  • src/agents/pi-embedded-helpers.sanitizesessionmessagesimages-thought-signature-stripping.test.ts
  • src/agents/pi-embedded-helpers.sanitizetoolcallid.test.ts
  • src/agents/pi-embedded-helpers.sanitizeuserfacingtext.test.ts
  • src/agents/pi-embedded-helpers.stripthoughtsignatures.test.ts
  • src/agents/pi-embedded-helpers.validate-turns.test.ts
  • src/agents/pi-embedded-runner-extraparams.live.test.ts(实时)
  • src/agents/pi-embedded-runner-extraparams.test.ts
  • src/agents/pi-embedded-runner.applygoogleturnorderingfix.test.ts
  • src/agents/pi-embedded-runner.buildembeddedsandboxinfo.test.ts
  • src/agents/pi-embedded-runner.createsystempromptoverride.test.ts
  • src/agents/pi-embedded-runner.get-dm-history-limit-from-session-key.falls-back-provider-default-per-dm-not.test.ts
  • src/agents/pi-embedded-runner.get-dm-history-limit-from-session-key.returns-undefined-sessionkey-is-undefined.test.ts
  • src/agents/pi-embedded-runner.google-sanitize-thinking.test.ts
  • src/agents/pi-embedded-runner.guard.test.ts
  • src/agents/pi-embedded-runner.limithistoryturns.test.ts
  • src/agents/pi-embedded-runner.resolvesessionagentids.test.ts
  • src/agents/pi-embedded-runner.run-embedded-pi-agent.auth-profile-rotation.test.ts
  • src/agents/pi-embedded-runner.sanitize-session-history.test.ts
  • src/agents/pi-embedded-runner.splitsdktools.test.ts
  • src/agents/pi-embedded-runner.test.ts
  • src/agents/pi-embedded-subscribe.code-span-awareness.test.ts
  • src/agents/pi-embedded-subscribe.reply-tags.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.calls-onblockreplyflush-before-tool-execution-start-preserve.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-append-text-end-content-is.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-call-onblockreplyflush-callback-is-not.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-duplicate-text-end-repeats-full.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-emit-duplicate-block-replies-text.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.emits-block-replies-text-end-does-not.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.emits-reasoning-as-separate-message-enabled.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.filters-final-suppresses-output-without-start-tag.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.includes-canvas-action-metadata-tool-summaries.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.keeps-assistanttexts-final-answer-block-replies-are.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.keeps-indented-fenced-blocks-intact.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.reopens-fenced-blocks-splitting-inside-them.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.splits-long-single-line-fenced-blocks-reopen.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.streams-soft-chunks-paragraph-preference.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.subscribeembeddedpisession.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.suppresses-message-end-block-replies-message-tool.test.ts
  • src/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.waits-multiple-compaction-retries-before-resolving.test.ts
  • src/agents/pi-embedded-subscribe.tools.test.ts
  • src/agents/pi-embedded-utils.test.ts
  • src/agents/pi-extensions/compaction-safeguard.test.ts
  • src/agents/pi-extensions/context-pruning.test.ts
  • src/agents/pi-settings.test.ts
  • src/agents/pi-tool-definition-adapter.test.ts
  • src/agents/pi-tools-agent-config.test.ts
  • src/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping-b.test.ts
  • src/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping-d.test.ts
  • src/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping-f.test.ts
  • src/agents/pi-tools.create-openclaw-coding-tools.adds-claude-style-aliases-schemas-without-dropping.test.ts
  • src/agents/pi-tools.policy.test.ts
  • src/agents/pi-tools.safe-bins.test.ts
  • src/agents/pi-tools.workspace-paths.test.ts