跳到主要内容

基础知识

Pi 集成架构

本文档描述了 OpenClaw 如何与 pi-coding-agent 及其相关包（pi-ai、pi-agent-core、pi-tui）集成，以提供 AI 智能体（agent）能力。

概述​

OpenClaw 使用 pi SDK 将 AI 编码智能体嵌入其消息网关（Gateway）架构中。OpenClaw 不是将 pi 作为子进程启动或使用 RPC 模式，而是通过 createAgentSession() 直接导入并实例化 pi 的 AgentSession。这种嵌入式方法提供了：

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

包依赖​

{
  "@mariozechner/pi-agent-core": "0.49.3",
  "@mariozechner/pi-ai": "0.49.3",
  "@mariozechner/pi-coding-agent": "0.49.3",
  "@mariozechner/pi-tui": "0.49.3"
}
包用途
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 vs 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               # 读取工具自定义
├── pi-tools.schema.ts             # 工具模式规范化
├── pi-tools.types.ts              # AnyAgentTool 类型别名
├── pi-tool-definition-adapter.ts  # AgentTool -> ToolDefinition 适配器
├── pi-settings.ts                 # 设置覆盖
├── pi-extensions/                 # 自定义 pi 扩展
│   ├── compaction-safeguard.ts    # 安全防护扩展
│   ├── compaction-safeguard-runtime.ts
│   ├── context-pruning.ts         # 基于缓存 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
│   ├── discord-actions*.ts
│   ├── gateway-tool.ts
│   ├── image-tool.ts
│   ├── message-tool.ts
│   ├── nodes-tool.ts
│   ├── session*.ts
│   ├── slack-actions.ts
│   ├── telegram-actions.ts
│   ├── web-*.ts
│   └── whatsapp-actions.ts
└── ...

核心集成流程​

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: "Hello, how are you?",
  provider: "anthropic",
  model: "claude-sonnet-4-20250514",
  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
  • auto_compaction_start / auto_compaction_end

4. 提示词​

设置完成后，向会话发送提示词：

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

SDK 处理完整的智能体循环：发送到 LLM、执行工具调用、流式响应。图像注入是提示词局部的：OpenClaw 从当前提示词加载图像引用，并仅通过该轮次的 images 传递。它不会重新扫描较早的历史轮次以重新注入图像负载。

工具架构​

工具流水线​

  1. 基础工具：pi 的 codingTools（read、bash、edit、write）
  2. 自定义替换：OpenClaw 将 bash 替换为 exec/process，为沙箱自定义 read/edit/write
  3. OpenClaw 工具：消息发送、浏览器、画布、会话、cron、网关等
  4. 频道工具：Discord/Telegram/Slack/WhatsApp 特定的操作工具
  5. 策略过滤：根据配置、提供商、智能体、群组、沙箱策略过滤工具
  6. 模式规范化：为 Gemini/OpenAI 的兼容性问题清理模式
  7. AbortSignal 包装：包装工具以响应中止信号

工具定义适配器​

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 的策略过滤、沙箱集成和扩展工具集在所有提供商之间保持一致。

系统提示词构建​

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

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

会话管理​

会话文件​

会话是具有树状结构（通过 id/parentId 链接）的 JSONL 文件。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() 根据频道类型（私信 vs 群组）精简对话历史记录。

压缩​

自动压缩在上下文溢出时触发。compactEmbeddedPiSessionDirect() 处理手动压缩：

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

认证与模型解析​

认证配置​

OpenClaw 维护一个认证配置存储，每个提供商有多个 API 密钥：

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

配置在失败时轮换，并跟踪冷却时间：

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-extensions/compaction-safeguard.ts 为压缩添加防护栏，包括自适应令牌预算以及工具失败和文件操作摘要：

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

上下文修剪​

src/agents/pi-extensions/context-pruning.ts 实现基于缓存 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;

思考/最终标签剥离​

流式输出经过处理，以剥离 حه/块并提取 内容：

const stripBlockTags = (text: string, state: { thinking: boolean; final: boolean }) => {
  // 剥离 حه...*/ 内容
  // 如果 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" | ...

思考级别回退​

如果某个思考级别不受支持，则回退：

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 在容器中运行
  // 浏览器使用桥接 URL
}

特定于提供商的处理​

Anthropic​

  • 拒绝魔法字符串清理
  • 连续角色的轮次验证
  • Claude Code 参数兼容性

Google/Gemini​

  • 轮次顺序修复（applyGoogleTurnOrderingFix）
  • 工具模式清理（sanitizeToolsForGoogle）
  • 会话历史清理（sanitizeSessionHistory）

OpenAI​

  • Codex 模型的 apply_patch 工具
  • 思考级别降级处理

TUI 集成​

OpenClaw 还有一个本地 TUI 模式，直接使用 pi-tui 组件：

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

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

与 Pi CLI 的主要区别​

方面Pi CLIOpenClaw 嵌入式
调用方式pi 命令 / RPC通过 createAgentSession() 的 SDK
工具默认编码工具自定义 OpenClaw 工具套件
系统提示词AGENTS.md + 提示词动态的每频道/上下文提示词
会话存储~/.pi/agent/sessions/~/.openclaw/agents//sessions/（或 $OPENCLAW_STATE_DIR/agents//sessions/）
认证单一凭证支持轮换的多配置
扩展从磁盘加载程序化 + 磁盘路径
事件处理TUI 渲染基于回调（onBlockReply 等）

未来考虑​

可能需要重新设计的领域：

  1. 工具签名对齐：目前正在适配 pi-agent-core 和 pi-coding-agent 之间的签名
  2. 会话管理器包装：guardSessionManager 增加了安全性但也增加了复杂性
  3. 扩展加载：可以更直接地使用 pi 的 ResourceLoader
  4. 流式处理器复杂性：subscribeEmbeddedPiSession 已变得庞大
  5. 提供商兼容处理：许多特定于提供商的代码路径，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-extensions/**/*.test.ts

实时/可选：

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

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

网关架构