跳转到主要内容

​
Pi 集成架构

本文档介绍 OpenClaw 如何与 pi-coding-agent 及其同级包（pi-ai、pi-agent-core、pi-tui）集成，以驱动其 AI 智能体能力。

​
概述

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

​
包依赖

{
  "@mariozechner/pi-agent-core": "0.68.1",
  "@mariozechner/pi-ai": "0.68.1",
  "@mariozechner/pi-coding-agent": "0.68.1",
  "@mariozechner/pi-tui": "0.68.1"
}
Package用途
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              # Vision 模型图像注入
│   │   └── 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         # 缓存 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           # Transcript 校验策略
├── skills.ts                      # Skills 快照/提示词构建
├── skills/                        # 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: "Hello, how are you?",
  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 将其传递给当前轮次。它不会重新扫描更早的历史轮次来重新注入图像负载。

​
工具架构

​
工具流水线

  1. 基础工具：pi 的 codingTools（read、bash、edit、write）
  2. 自定义替换：OpenClaw 将 bash 替换为 exec/process，并为沙箱定制 read/edit/write
  3. OpenClaw 工具：消息、浏览器、画布、会话、cron、Gateway 网关等
  4. 渠道工具：Discord/Telegram/Slack/WhatsApp 特定操作工具
  5. 策略过滤：按配置、提供商、智能体、群组、沙箱策略过滤工具
  6. Schema 规范化：为兼容 Gemini/OpenAI 的特殊行为而清理 schema
  7. AbortSignal 包装：对工具进行包装，以遵守 abort signal

​
工具定义适配器

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）中构建。它会组装一个完整提示词，其中包含 Tooling、工具调用风格、安全护栏、OpenClaw CLI 参考、Skills、文档、工作区、沙箱、消息、回复标签、语气、静默回复、心跳、运行时元数据，以及在启用时包含的 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() 会根据渠道类型（私信 与 群组）裁剪对话历史。

​
压缩

当上下文溢出时会触发自动压缩。常见的溢出特征包括 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, ...
});

​
认证与模型解析

​
凭证配置

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-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 实现了基于缓存 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 为 true，则只返回 <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 level 回退

如果某个 thinking level 不受支持，则会回退： 
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 使用 bridge URL
}

​
提供商特定处理

​
Anthropic

  • 拒绝魔术字符串清理
  • 连续角色的轮次校验
  • 严格的上游 Pi 工具参数校验

​
Google/Gemini

  • 插件自有的工具 schema 清理

​
OpenAI

  • 面向 Codex 模型的 apply_patch 工具
  • thinking level 降级处理

​
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 + prompts按渠道/上下文动态生成
会话存储~/.pi/agent/sessions/~/.openclaw/agents/<agentId>/sessions/（或 $OPENCLAW_STATE_DIR/agents/<agentId>/sessions/）
认证单一凭证支持轮换的多配置
扩展从磁盘加载编程方式 + 磁盘路径
事件处理TUI 渲染基于回调（onBlockReply 等）

​
未来考虑

潜在需要重构的领域：
  1. 工具签名对齐：当前需要在 pi-agent-core 与 pi-coding-agent 签名之间做适配
  2. Session manager 包装：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-hooks/**/*.test.ts
实时/按需启用：
  • src/agents/pi-embedded-runner-extraparams.live.test.ts（启用 OPENCLAW_LIVE_TEST=1）
关于当前运行命令，请参见 Pi Development Workflow。