Pi 整合架構

本文件描述 OpenClaw 如何與 pi-coding-agent 及其姊妹套件（pi-ai、pi-agent-core、pi-tui）整合，為其 AI Agent 功能提供動力。

概覽

OpenClaw 使用 pi SDK 將 AI 程式碼代理嵌入其訊息閘道架構。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-coreAgent 迴圈、工具執行、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                 # 歷史限制（DM 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-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. 執行嵌入式 Agent

主要入口是 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 會處理完整的 Agent 迴圈：傳送到 LLM、執行工具呼叫、串流回應。

圖片注入是提示層級的：OpenClaw 從目前提示中載入圖片參照，僅在該回合透過 images 傳入。它不會重新掃描舊的歷史回合來重新注入圖片酬載。

工具架構

工具管線

  1. 基礎工具：pi 的 codingTools（read、bash、edit、write）
  2. 自訂替換：OpenClaw 用 exec/process 取代 bash，為沙箱客製 read/edit/write
  3. OpenClaw 工具：訊息、瀏覽器、Canvas、工作階段、排程、Gateway 等
  4. 頻道工具：Discord/Telegram/Slack/WhatsApp 專屬的操作工具
  5. 策略篩選：依設定檔、供應商、Agent、群組、沙箱策略篩選工具
  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 的簽章與 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 的策略篩選、沙箱整合和擴充工具集在不同供應商之間保持一致。

系統提示詞建構

系統提示詞在 system-prompt.ts 的 buildAgentSystemPrompt() 中組裝。它會組合一份完整的提示詞，包含 Tooling、Tool Call Style、安全護欄、OpenClaw CLI 參考、Skills、Docs、Workspace、Sandbox、Messaging、Reply Tags、Voice、Silent Replies、Heartbeats、Runtime 後設資料等區段，以及啟用時的 Memory 和 Reactions，還有選用的上下文檔案和額外的系統提示詞內容。子代理使用的最小提示模式會裁減部分區段。

提示詞在工作階段建立後透過 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() 依頻道類型（DM 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 為壓縮增加護欄，包括自適應 token 預算，以及工具失敗與檔案操作摘要：

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;

思考／最終標籤剝離

串流輸出會經過處理，剝離 <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" | ...

思考層級退回

若不支援某個思考層級，會自動退回：

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 在容器中執行
  // 瀏覽器使用 bridge URL
}

供應商專屬處理

Anthropic

  • 拒絕回應的魔法字串清理
  • 連續角色的回合驗證
  • Claude Code 參數相容性

Google/Gemini

  • 回合排序修正（applyGoogleTurnOrderingFix）
  • 工具 schema 清理（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 指令 / RPCSDK 透過 createAgentSession()
工具預設程式碼工具自訂 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. SessionManager 封裝：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 開發工作流程。

arrow_back
上一頁
Troubleshooting
下一頁
Architecture
arrow_forward