Pi 集成架构 - OpenClaw 中文文档

OpenClaw 集成了 pi-coding-agent 及其相关包（pi-ai、pi-agent-core、pi-tui），以支持其 AI 代理能力。

概览

OpenClaw 使用 pi SDK 将一个 AI 编码代理嵌入到其消息网关架构中。与其作为子进程启动 pi 或使用 RPC 模式不同，OpenClaw 直接通过 createAgentSession() 导入并实例化 pi 的 AgentSession。这种嵌入式方式提供了：

对会话生命周期和事件处理的完全控制
自定义工具注入（消息、沙箱、特定频道动作）
按频道/上下文自定义系统提示词
支持分支/压缩的会话持久化
带故障切换的多账号认证配置轮换
与提供方无关的模型切换

包依赖

{
  "@mariozechner/pi-agent-core": "0.70.2",
  "@mariozechner/pi-ai": "0.70.2",
  "@mariozechner/pi-coding-agent": "0.70.2",
  "@mariozechner/pi-tui": "0.70.2"
}

包	用途
`pi-ai`	核心 LLM 抽象：`Model`、`streamSimple`、消息类型、提供方 API
`pi-agent-core`	代理循环、工具执行、`AgentMessage` 类型
`pi-coding-agent`	高层 SDK：`createAgentSession`、`SessionManager`、`AuthStorage`、`ModelRegistry`、内置工具
`pi-tui`	终端 UI 组件（在 OpenClaw 的本地 TUI 模式中使用）

文件结构

src/agents/
├── pi-embedded-runner.ts          # 从 pi-embedded-runner/ 重新导出
├── pi-embedded-runner/
│   ├── run.ts                     # 主入口：runEmbeddedPiAgent()
│   ├── run/
│   │   ├── attempt.ts             # 单次尝试逻辑，包含会话设置
│   │   ├── params.ts              # RunEmbeddedPiAgentParams 类型
│   │   ├── payloads.ts            # 根据运行结果构建响应载荷
│   │   ├── images.ts              # 视觉模型图片注入
│   │   └── types.ts               # EmbeddedRunAttemptResult
│   ├── abort.ts                   # 中止错误检测
│   ├── cache-ttl.ts               # 上下文裁剪的缓存 TTL 跟踪
│   ├── compact.ts                 # 手动/自动压缩逻辑
│   ├── extensions.ts              # 为嵌入式运行加载 pi 扩展
│   ├── extra-params.ts            # 提供方特定的流式参数
│   ├── google.ts                  # Google/Gemini 回合顺序修复
│   ├── history.ts                 # 历史限制（私聊 vs 群组）
│   ├── lanes.ts                   # 会话/全局命令通道
│   ├── logger.ts                  # 子系统日志器
│   ├── model.ts                   # 通过 ModelRegistry 解析模型
│   ├── runs.ts                    # 活动运行跟踪、中止、队列
│   ├── sandbox-info.ts            # 用于系统提示词的沙箱信息
│   ├── session-manager-cache.ts   # SessionManager 实例缓存
│   ├── session-manager-init.ts    # 会话文件初始化
│   ├── system-prompt.ts           # 系统提示词构建器
│   ├── tool-split.ts              # 将工具拆分为 builtIn 与 custom
│   ├── types.ts                   # EmbeddedPiAgentMeta、EmbeddedPiRunResult
│   └── utils.ts                   # ThinkLevel 映射、错误描述
├── pi-embedded-subscribe.ts       # 会话事件订阅/分发
├── pi-embedded-subscribe.types.ts # SubscribeEmbeddedPiSessionParams
├── pi-embedded-subscribe.handlers.ts # 事件处理器工厂
├── pi-embedded-subscribe.handlers.lifecycle.ts
├── pi-embedded-subscribe.handlers.types.ts
├── pi-embedded-block-chunker.ts   # 流式块回复分块
├── pi-embedded-messaging.ts       # 消息工具发送跟踪
├── pi-embedded-helpers.ts         # 错误分类、回合校验
├── pi-embedded-helpers/           # 辅助模块
├── pi-embedded-utils.ts           # 格式化工具
├── pi-tools.ts                    # createOpenClawCodingTools()
├── pi-tools.abort.ts              # 工具的 AbortSignal 包装
├── pi-tools.policy.ts             # 工具白名单/黑名单策略
├── pi-tools.read.ts               # Read 工具自定义
├── pi-tools.schema.ts             # 工具 schema 规范化
├── pi-tools.types.ts              # AnyAgentTool 类型别名
├── pi-tool-definition-adapter.ts  # AgentTool -> ToolDefinition 适配器
├── pi-settings.ts                 # 设置覆盖
├── pi-hooks/                      # 自定义 pi hooks
│   ├── compaction-safeguard.ts    # 安全防护扩展
│   ├── compaction-safeguard-runtime.ts
│   ├── context-pruning.ts         # Cache-TTL 上下文裁剪扩展
│   └── context-pruning/
├── model-auth.ts                  # 认证配置文件解析
├── auth-profiles.ts               # 配置文件存储、冷却、故障切换
├── model-selection.ts             # 默认模型解析
├── models-config.ts               # models.json 生成
├── model-catalog.ts               # 模型目录缓存
├── context-window-guard.ts        # 上下文窗口校验
├── failover-error.ts              # FailoverError 类
├── defaults.ts                    # DEFAULT_PROVIDER、DEFAULT_MODEL
├── system-prompt.ts               # buildAgentSystemPrompt()
├── system-prompt-params.ts        # 系统提示词参数解析
├── system-prompt-report.ts        # 调试报告生成
├── tool-summaries.ts              # 工具描述摘要
├── tool-policy.ts                 # 工具策略解析
├── transcript-policy.ts           # 转录校验策略
├── skills.ts                      # 技能快照/提示词构建
├── skills/                        # 技能子系统
├── sandbox.ts                     # 沙箱上下文解析
├── sandbox/                       # 沙箱子系统
├── channel-tools.ts               # 特定频道工具注入
├── openclaw-tools.ts              # OpenClaw 专用工具
├── bash-tools.ts                  # exec/process 工具
├── apply-patch.ts                 # apply_patch 工具（OpenAI）
├── tools/                         # 单个工具实现
│   ├── browser-tool.ts
│   ├── canvas-tool.ts
│   ├── cron-tool.ts
│   ├── gateway-tool.ts
│   ├── image-tool.ts
│   ├── message-tool.ts
│   ├── nodes-tool.ts
│   ├── session*.ts
│   ├── web-*.ts
│   └── ...
└── ...

特定频道的消息动作运行时现在位于插件拥有的扩展目录中，而不是 src/agents/tools 下，例如：

Discord 插件动作运行时文件
Slack 插件动作运行时文件
Telegram 插件动作运行时文件
WhatsApp 插件动作运行时文件

核心集成流程

1. 运行嵌入式代理

主入口是 pi-embedded-runner/run.ts 中的 runEmbeddedPiAgent()：

import { runEmbeddedPiAgent } from "./agents/pi-embedded-runner.js";

const result = await runEmbeddedPiAgent({
  sessionId: "user-123",
  sessionKey: "main:whatsapp:+1234567890",
  sessionFile: "/path/to/session.jsonl",
  workspaceDir: "/path/to/workspace",
  config: openclawConfig,
  prompt: "你好，你怎么样？",
  provider: "anthropic",
  model: "claude-sonnet-4-6",
  timeoutMs: 120_000,
  runId: "run-abc",
  onBlockReply: async (payload) => {
    await sendToChannel(payload.text, payload.mediaUrls);
  },
});

2. 会话创建

在 runEmbeddedAttempt()（由 runEmbeddedPiAgent() 调用）内部，使用了 pi SDK：

import {
  createAgentSession,
  DefaultResourceLoader,
  SessionManager,
  SettingsManager,
} from "@mariozechner/pi-coding-agent";

const resourceLoader = new DefaultResourceLoader({
  cwd: resolvedWorkspace,
  agentDir,
  settingsManager,
  additionalExtensionPaths,
});
await resourceLoader.reload();

const { session } = await createAgentSession({
  cwd: resolvedWorkspace,
  agentDir,
  authStorage: params.authStorage,
  modelRegistry: params.modelRegistry,
  model: params.model,
  thinkingLevel: mapThinkingLevel(params.thinkLevel),
  tools: builtInTools,
  customTools: allCustomTools,
  sessionManager,
  settingsManager,
  resourceLoader,
});

applySystemPromptOverrideToSession(session, systemPromptOverride);

3. 事件订阅

subscribeEmbeddedPiSession() 订阅 pi 的 AgentSession 事件：

const subscription = subscribeEmbeddedPiSession({
  session: activeSession,
  runId: params.runId,
  verboseLevel: params.verboseLevel,
  reasoningMode: params.reasoningLevel,
  toolResultFormat: params.toolResultFormat,
  onToolResult: params.onToolResult,
  onReasoningStream: params.onReasoningStream,
  onBlockReply: params.onBlockReply,
  onPartialReply: params.onPartialReply,
  onAgentEvent: params.onAgentEvent,
});

处理的事件包括：

message_start / message_end / message_update（流式文本/思考）
tool_execution_start / tool_execution_update / tool_execution_end
turn_start / turn_end
agent_start / agent_end
compaction_start / compaction_end

4. 提示

在完成设置后，会对会话发起提示：

await session.prompt(effectivePrompt, { images: imageResult.images });

SDK 会处理完整的代理循环：发送到 LLM、执行工具调用、流式输出响应。图片注入是仅限于当前提示的：OpenClaw 会从当前提示中加载图片引用，并且仅在该轮通过 images 传入。它不会重新扫描较早的历史轮次来重新注入图片载荷。

工具架构

工具流水线

基础工具：pi 的 codingTools（read、bash、edit、write）
自定义替换：OpenClaw 用 exec/process 替换 bash，并为沙箱定制 read/edit/write
OpenClaw 工具：messaging、browser、canvas、sessions、cron、gateway 等
通道工具：Discord/Telegram/Slack/WhatsApp 专用的动作工具
策略过滤：根据 profile、provider、agent、group、sandbox 策略过滤工具
Schema 规范化：清理 Schema 以适配 Gemini/OpenAI 的一些特殊行为
AbortSignal 包装：对工具进行包装以遵守 abort 信号

工具定义适配器

pi-agent-core 的 AgentTool 与 pi-coding-agent 的 ToolDefinition 具有不同的 execute 签名。pi-tool-definition-adapter.ts 中的适配器负责桥接：

export function toToolDefinitions(tools: AnyAgentTool[]): ToolDefinition[] {
  return tools.map((tool) => ({
    name: tool.name,
    label: tool.label ?? name,
    description: tool.description ?? "",
    parameters: tool.parameters,
    execute: async (toolCallId, params, onUpdate, _ctx, signal) => {
      // pi-coding-agent 的签名与 pi-agent-core 不同
      return await tool.execute(toolCallId, params, signal, onUpdate);
    },
  }));
}

工具拆分策略

splitSdkTools() 通过 customTools 传递所有工具：

export function splitSdkTools(options: { tools: AnyAgentTool[]; sandboxEnabled: boolean }) {
  return {
    builtInTools: [], // 为空。我们覆盖一切
    customTools: toToolDefinitions(options.tools),
  };
}

这确保 OpenClaw 的策略过滤、沙箱集成和扩展工具集在不同 provider 之间保持一致。

系统提示词构建

系统提示词在 buildAgentSystemPrompt()（system-prompt.ts）中构建。它会组装一个完整的提示词，包含 Tooling、Tool Call Style、Safety guardrails、OpenClaw CLI reference、Skills、Docs、Workspace、Sandbox、Messaging、Reply Tags、Voice、Silent Replies、Heartbeats、Runtime metadata 等章节；在启用时还会加入 Memory 和 Reactions，以及可选的上下文文件和额外系统提示词内容。对于子代理使用的最小提示词模式，这些章节会被裁剪。提示词在会话创建后通过 applySystemPromptOverrideToSession() 应用：

const systemPromptOverride = createSystemPromptOverride(appendPrompt);
applySystemPromptOverrideToSession(session, systemPromptOverride);

会话管理

会话文件

会话是带有树结构的 JSONL 文件（通过 id/parentId 关联）。Pi 的 SessionManager 负责持久化：

const sessionManager = SessionManager.open(params.sessionFile);

OpenClaw 使用 guardSessionManager() 对其进行包装，以确保工具结果安全。

会话缓存

session-manager-cache.ts 会缓存 SessionManager 实例，以避免重复解析文件：

await prewarmSessionFile(params.sessionFile);
sessionManager = SessionManager.open(params.sessionFile);
trackSessionManagerAccess(params.sessionFile);

历史限制

limitHistoryTurns() 会根据通道类型（DM vs group）裁剪对话历史。

压缩

当上下文溢出时会触发自动压缩。常见的溢出特征包括 request_too_large、context length exceeded、input exceeds the maximum number of tokens、input token count exceeds the maximum number of input tokens、input is too long for the model 以及 ollama error: context length exceeded。compactEmbeddedPiSessionDirect() 处理手动压缩：

const compactResult = await compactEmbeddedPiSessionDirect({
  sessionId, sessionFile, provider, model, ...
});

认证与模型解析

认证 profile

OpenClaw 维护一个认证 profile 存储，为每个 provider 支持多个 API key：

const authStore = ensureAuthProfileStore(agentDir, { allowKeychainPrompt: false });
const profileOrder = resolveAuthProfileOrder({ cfg, store: authStore, provider, preferredProfile });

profile 会在失败时轮换，并带有冷却追踪：

await markAuthProfileFailure({ store, profileId, reason, cfg, agentDir });
const rotated = await advanceAuthProfile();

模型解析

import { resolveModel } from "./pi-embedded-runner/model.js";

const { model, error, authStorage, modelRegistry } = resolveModel(
  provider,
  modelId,
  agentDir,
  config,
);

// 使用 pi 的 ModelRegistry 和 AuthStorage
authStorage.setRuntimeApiKey(model.provider, apiKeyInfo.apiKey);

故障转移

当配置了模型回退时，FailoverError 会触发模型降级：

if (fallbackConfigured && isFailoverErrorMessage(errorText)) {
  throw new FailoverError(errorText, {
    reason: promptFailoverReason ?? "unknown",
    provider,
    model: modelId,
    profileId,
    status: resolveFailoverStatus(promptFailoverReason),
  });
}

Pi 扩展

OpenClaw 会加载自定义 pi 扩展以实现专门行为：

压缩保护措施

src/agents/pi-hooks/compaction-safeguard.ts 为压缩增加保护，包括自适应 token 预算以及工具失败和文件操作摘要：

if (resolveCompactionMode(params.cfg) === "safeguard") {
  setCompactionSafeguardRuntime(params.sessionManager, { maxHistoryShare });
  paths.push(resolvePiExtensionPath("compaction-safeguard"));
}

上下文修剪

src/agents/pi-hooks/context-pruning.ts 实现了基于 cache-TTL 的上下文修剪：

if (cfg?.agents?.defaults?.contextPruning?.mode === "cache-ttl") {
  setContextPruningRuntime(params.sessionManager, {
    settings,
    contextWindowTokens,
    isToolPrunable,
    lastCacheTouchAt,
  });
  paths.push(resolvePiExtensionPath("context-pruning"));
}

流式输出与块回复

块分片

EmbeddedBlockChunker 负责将流式文本管理为离散的回复块：

const blockChunker = blockChunking ? new EmbeddedBlockChunker(blockChunking) : null;

Thinking/Final 标签剥离

流式输出会经过处理，以剥离 <think>/<thinking> 块并提取 <final> 内容：

const stripBlockTags = (text: string, state: { thinking: boolean; final: boolean }) => {
  // 剥离 <think>...</think> 内容
  // 如果 enforceFinalTag，则仅返回 <final>...</final> 内容
};

回复指令

像 [[media:url]]、[[voice]]、[[reply:id]] 这样的回复指令会被解析并提取：

const { text: cleanedText, mediaUrls, audioAsVoice, replyToId } = consumeReplyDirectives(chunk);

错误处理

错误分类

pi-embedded-helpers.ts 会对错误进行分类，以便正确处理：

isContextOverflowError(errorText)     // 上下文过大
isCompactionFailureError(errorText)   // 压缩失败
isAuthAssistantError(lastAssistant)   // 认证失败
isRateLimitAssistantError(...)        // 触发速率限制
isFailoverAssistantError(...)         // 应该进行故障转移
classifyFailoverReason(errorText)     // "auth" | "rate_limit" | "quota" | "timeout" | ...

Thinking 级别回退

如果某个 thinking 级别不受支持，则会回退：

const fallbackThinking = pickFallbackThinkingLevel({
  message: errorText,
  attempted: attemptedThinking,
});
if (fallbackThinking) {
  thinkLevel = fallbackThinking;
  continue;
}

沙箱集成

当启用沙箱模式时，工具和路径会受到限制：

const sandbox = await resolveSandboxContext({
  config: params.config,
  sessionKey: sandboxSessionKey,
  workspaceDir: resolvedWorkspace,
});

if (sandboxRoot) {
  // 使用沙箱化的 read/edit/write 工具
  // Exec 在容器中运行
  // Browser 使用桥接 URL
}

provider 特定处理

Anthropic

清理拒绝（refusal）魔法字符串
对连续角色进行轮次校验
严格的上游 Pi 工具参数校验

Google/Gemini

插件拥有的工具 schema 清理

OpenAI

为 Codex 模型提供 apply_patch 工具
thinking 级别降级处理

TUI 集成

OpenClaw 还提供本地 TUI 模式，直接使用 pi-tui 组件：

// src/tui/tui.ts
import { ... } from "@mariozechner/pi-tui";

这提供了类似 pi 原生模式的交互式终端体验。

与 Pi CLI 的关键差异

方面	Pi CLI	OpenClaw Embedded
调用方式	`pi` 命令 / RPC	通过 `createAgentSession()` 的 SDK
工具	默认 coding 工具	自定义 OpenClaw 工具套件
系统提示词	AGENTS.md + prompts	按通道/上下文动态生成
会话存储	`~/.pi/agent/sessions/`	`~/.openclaw/agents/<agentId>/sessions/`（或 `$OPENCLAW_STATE_DIR/agents/<agentId>/sessions/`）
认证	单一凭证	带轮换的多 profile
扩展	从磁盘加载	程序化 + 磁盘路径
事件处理	TUI 渲染	基于回调（onBlockReply 等）

未来考虑

可能需要重构的领域：

工具签名对齐：目前正在 pi-agent-core 和 pi-coding-agent 签名之间进行适配
会话管理器包装：guardSessionManager 增加了安全性，但也提高了复杂度
扩展加载：可以更直接地使用 pi 的 ResourceLoader
流式处理器复杂性：subscribeEmbeddedPiSession 已经变得很大
provider 特殊行为：存在许多 provider 特定代码路径，而这些理论上可能由 pi 处理

测试

Pi 集成覆盖以下测试套件：

src/agents/pi-*.test.ts
src/agents/pi-auth-json.test.ts
src/agents/pi-embedded-*.test.ts
src/agents/pi-embedded-helpers*.test.ts
src/agents/pi-embedded-runner*.test.ts
src/agents/pi-embedded-runner/**/*.test.ts
src/agents/pi-embedded-subscribe*.test.ts
src/agents/pi-tools*.test.ts
src/agents/pi-tool-definition-adapter*.test.ts
src/agents/pi-settings.test.ts
src/agents/pi-hooks/**/*.test.ts

实时/可选择启用：

src/agents/pi-embedded-runner-extraparams.live.test.ts（启用 OPENCLAW_LIVE_TEST=1）

有关当前运行命令，请参阅 Pi 开发工作流。

CLI 命令

RPC 与 API

模板

技术参考

概念内部机制

项目

发布与 CI

Documentation Index

​概览

​包依赖

​文件结构

​核心集成流程

​1. 运行嵌入式代理

​2. 会话创建

​3. 事件订阅

​4. 提示

​工具架构

​工具流水线

​工具定义适配器

​工具拆分策略

​系统提示词构建

​会话管理

​会话文件

​会话缓存

​历史限制

​压缩

​认证与模型解析

​认证 profile

​模型解析

​故障转移

​Pi 扩展

​压缩保护措施

​上下文修剪

​流式输出与块回复

​块分片

​Thinking/Final 标签剥离

​回复指令

​错误处理

​错误分类

​Thinking 级别回退

​沙箱集成

​provider 特定处理

​Anthropic

​Google/Gemini

​OpenAI

​TUI 集成

​与 Pi CLI 的关键差异

​未来考虑

​测试

​相关内容

概览

包依赖