跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenClaw 整合了 pi-coding-agent 及其同級套件（pi-ai、pi-agent-core、pi-tui），以支援其 AI 代理能力。

​
概觀

OpenClaw 使用 pi SDK 將 AI 程式設計代理嵌入其訊息 Gateway 架構。OpenClaw 不會將 pi 作為子程序啟動，也不使用 RPC 模式，而是直接匯入並透過 createAgentSession() 實例化 pi 的 AgentSession。這種嵌入式做法提供：
  • 對工作階段生命週期與事件處理的完整控制
  • 自訂工具注入（訊息、沙箱、通道特定動作）
  • 依通道/情境自訂系統提示
  • 支援分支/Compaction 的工作階段持久化
  • 具備容錯移轉的多帳號驗證設定檔輪替
  • 與提供者無關的模型切換

​
套件相依性

{
  "@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          # 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
│   └── ...
└── ...
通道特定訊息動作執行階段現在位於 Plugin 擁有的 extension 目錄中，而不是 src/agents/tools 之下，例如：
  • Discord Plugin 動作執行階段檔案
  • Slack Plugin 動作執行階段檔案
  • Telegram Plugin 動作執行階段檔案
  • WhatsApp Plugin 動作執行階段檔案

​
核心整合流程

​
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 以 exec/process 取代 bash，並為沙箱自訂 read/edit/write
  3. OpenClaw 工具：訊息、瀏覽器、畫布、工作階段、Cron、Gateway 等
  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 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、安全防護措施、OpenClaw CLI 參考、Skills、文件、工作區、沙箱、訊息、回覆標籤、語音、靜默回覆、Heartbeat、執行階段中繼資料等區段，並在啟用時包含 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 或群組）裁剪對話歷史。

​
Compaction

自動 Compaction 會在情境溢位時觸發。常見的溢位特徵包括 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() 會處理手動 Compaction： 
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,
);

// 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 擴充，以支援專門行為：

​
Compaction 防護

src/agents/pi-hooks/compaction-safeguard.ts 會為 Compaction 加入防護措施，包括自適應 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 }) => {
  // 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

  • 拒絕 magic string 清理
  • 連續角色的回合驗證
  • 嚴格的上游 Pi 工具參數驗證

​
Google/Gemini

  • Plugin 擁有的工具結構描述清理

​
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 + prompts依頻道/情境動態產生
工作階段儲存~/.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 開發工作流程。

​
相關