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.73.0",
  "@mariozechner/pi-ai": "0.73.0",
  "@mariozechner/pi-coding-agent": "0.73.0",
  "@mariozechner/pi-tui": "0.73.0"
}

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

# 文件结构

src/agents/
├── pi-embedded-runner.ts          # Re-exports from pi-embedded-runner/
├── pi-embedded-runner/
│   ├── run.ts                     # Main entry: runEmbeddedPiAgent()
│   ├── run/
│   │   ├── attempt.ts             # Single attempt logic with session setup
│   │   ├── params.ts              # RunEmbeddedPiAgentParams type
│   │   ├── payloads.ts            # Build response payloads from run results
│   │   ├── images.ts              # Vision model image injection
│   │   └── types.ts               # EmbeddedRunAttemptResult
│   ├── abort.ts                   # Abort error detection
│   ├── cache-ttl.ts               # Cache TTL tracking for context pruning
│   ├── compact.ts                 # Manual/auto compaction logic
│   ├── extensions.ts              # Load pi extensions for embedded runs
│   ├── extra-params.ts            # Provider-specific stream params
│   ├── google.ts                  # Google/Gemini turn ordering fixes
│   ├── history.ts                 # History limiting (DM vs group)
│   ├── lanes.ts                   # Session/global command lanes
│   ├── logger.ts                  # Subsystem logger
│   ├── model.ts                   # Model resolution via ModelRegistry
│   ├── runs.ts                    # Active run tracking, abort, queue
│   ├── sandbox-info.ts            # Sandbox info for system prompt
│   ├── session-manager-cache.ts   # SessionManager instance caching
│   ├── session-manager-init.ts    # Session file initialization
│   ├── system-prompt.ts           # System prompt builder
│   ├── tool-split.ts              # Split tools into builtIn vs custom
│   ├── types.ts                   # EmbeddedPiAgentMeta, EmbeddedPiRunResult
│   └── utils.ts                   # ThinkLevel mapping, error description
├── pi-embedded-subscribe.ts       # Session event subscription/dispatch
├── pi-embedded-subscribe.types.ts # SubscribeEmbeddedPiSessionParams
├── pi-embedded-subscribe.handlers.ts # Event handler factory
├── pi-embedded-subscribe.handlers.lifecycle.ts
├── pi-embedded-subscribe.handlers.types.ts
├── pi-embedded-block-chunker.ts   # Streaming block reply chunking
├── pi-embedded-messaging.ts       # Messaging tool sent tracking
├── pi-embedded-helpers.ts         # Error classification, turn validation
├── pi-embedded-helpers/           # Helper modules
├── pi-embedded-utils.ts           # Formatting utilities
├── pi-tools.ts                    # createOpenClawCodingTools()
├── pi-tools.abort.ts              # AbortSignal wrapping for tools
├── pi-tools.policy.ts             # Tool allowlist/denylist policy
├── pi-tools.read.ts               # Read tool customizations
├── pi-tools.schema.ts             # Tool schema normalization
├── pi-tools.types.ts              # AnyAgentTool type alias
├── pi-tool-definition-adapter.ts  # AgentTool -> ToolDefinition adapter
├── pi-settings.ts                 # Settings overrides
├── pi-hooks/                      # Custom pi hooks
│   ├── compaction-safeguard.ts    # Safeguard extension
│   ├── compaction-safeguard-runtime.ts
│   ├── context-pruning.ts         # Cache-TTL context pruning extension
│   └── context-pruning/
├── model-auth.ts                  # Auth profile resolution
├── auth-profiles.ts               # Profile store, cooldown, failover
├── model-selection.ts             # Default model resolution
├── models-config.ts               # models.json generation
├── model-catalog.ts               # Model catalog cache
├── context-window-guard.ts        # Context window validation
├── failover-error.ts              # FailoverError class
├── defaults.ts                    # DEFAULT_PROVIDER, DEFAULT_MODEL
├── system-prompt.ts               # buildAgentSystemPrompt()
├── system-prompt-params.ts        # System prompt parameter resolution
├── system-prompt-report.ts        # Debug report generation
├── tool-summaries.ts              # Tool description summaries
├── tool-policy.ts                 # Tool policy resolution
├── transcript-policy.ts           # Transcript validation policy
├── skills.ts                      # Skill snapshot/prompt building
├── skills/                        # Skill subsystem
├── sandbox.ts                     # Sandbox context resolution
├── sandbox/                       # Sandbox subsystem
├── channel-tools.ts               # Channel-specific tool injection
├── openclaw-tools.ts              # OpenClaw-specific tools
├── bash-tools.ts                  # exec/process tools
├── apply-patch.ts                 # apply_patch tool (OpenAI)
├── tools/                         # Individual tool implementations
│   ├── 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
│   └── ...
└── ...

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

• Discord 插件操作运行时文件
• Slack 插件操作运行时文件
• Telegram 插件操作运行时文件
• WhatsApp 插件操作运行时文件

# 核心集成流程

# 1. 运行嵌入式智能体

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

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：

  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 处理完整的 Agent loop：发送给 LLM、执行工具调用、流式传输响应。

图像注入仅限当前提示词：OpenClaw 从当前提示词加载图像引用，并 仅针对该轮次通过 images 传递它们。它不会重新扫描较早的历史轮次 来重新注入图像载荷。

# 工具架构

# 工具流水线

1. 基础工具：pi 的 codingTools（read、bash、edit、write）
2. 自定义替换：OpenClaw 用 exec/process 替换 bash，并为沙箱自定义 read/edit/write
3. OpenClaw 工具：消息、浏览器、画布、会话、cron、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 中的适配器用于衔接两者：

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 signature differs from pi-agent-core
      return await tool.execute(toolCallId, params, signal, onUpdate);
    },
  }));
}

# 工具拆分策略

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

export function splitSdkTools(options: { tools: AnyAgentTool[]; sandboxEnabled: boolean }) {
  return {
    builtInTools: [], // Empty. We override everything
    customTools: toToolDefinitions(options.tools),
  };
}

这确保 OpenClaw 的策略过滤、沙箱集成和扩展工具集在各提供商之间保持一致。

# 系统提示构建

系统提示在 buildAgentSystemPrompt()（system-prompt.ts）中构建。它会组装完整提示，包含 Tooling、Tool Call Style、Safety guardrails、OpenClaw CLI 参考、Skills、Docs、工作区、沙箱、消息、回复标签、语音、静默回复、Heartbeats、运行时元数据等部分，并在启用时包含记忆和反应，以及可选的上下文文件和额外系统提示内容。用于子智能体的最小提示模式会裁剪这些部分。

提示会在创建会话后通过 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() 会根据渠道类型（私信与群组）裁剪对话历史。

# 压缩

上下文溢出时会触发自动压缩。常见溢出特征包括 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 key：

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();

# 模型解析

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

// Uses pi's ModelRegistry and 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 会为压缩添加保护机制，包括自适应令牌预算，以及工具失败和文件操作摘要：

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 }) => {
  // Strip <think>...</think> content
  // If enforceFinalTag, only return <final>...</final> content
};

# 回复指令

会解析并提取 [[media:url]]、[[voice]]、[[reply:id]] 等回复指令：

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

# 错误处理

# 错误分类

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

isContextOverflowError(errorText)     // Context too large
isCompactionFailureError(errorText)   // Compaction failed
isAuthAssistantError(lastAssistant)   // Auth failure
isRateLimitAssistantError(...)        // Rate limited
isFailoverAssistantError(...)         // Should failover
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) {
  // Use sandboxed read/edit/write tools
  // Exec runs in container
  // Browser uses bridge URL
}

# 特定提供商处理

# Anthropic

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

# Google/Gemini

• 插件自有的工具 schema 清理

# OpenAI

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

# TUI 集成

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

// src/tui/tui.ts

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

# 与 Pi CLI 的主要区别

方面	Pi CLI	OpenClaw 嵌入式
调用方式	pi 命令 / RPC	通过 createAgentSession() 使用 SDK
工具	默认编码工具	自定义 OpenClaw 工具套件
系统提示	AGENTS.md + 提示	按渠道/上下文动态生成
会话存储	~/.pi/agent/sessions/	~/.openclaw/agents/<agentId>/sessions/（或 $OPENCLAW_STATE_DIR/agents/<agentId>/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-hooks/**/*.test.ts

实时/选择加入：

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

当前运行命令见 Pi 开发工作流。

# 相关内容

• Pi 开发工作流
• 安装概览