Technical reference
Pi 統合アーキテクチャ
OpenClaw は pi-coding-agent とその兄弟パッケージ(pi-ai、pi-agent-core、pi-tui)を統合し、AI エージェント機能を支えています。
概要
OpenClaw は pi SDK を使用して、メッセージング Gateway アーキテクチャに AI コーディングエージェントを組み込みます。pi をサブプロセスとして起動したり RPC モードを使用したりする代わりに、OpenClaw は createAgentSession() を通じて pi の AgentSession を直接インポートしてインスタンス化します。この組み込み方式には次の利点があります。
- セッションのライフサイクルとイベント処理を完全に制御
- カスタムツール注入(メッセージング、サンドボックス、チャネル固有のアクション)
- チャネル/コンテキストごとのシステムプロンプトのカスタマイズ
- 分岐/Compaction サポート付きのセッション永続化
- フェイルオーバー付きの複数アカウント認証プロファイルローテーション
- プロバイダーに依存しないモデル切り替え
パッケージ依存関係
{
"@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 |
エージェントループ、ツール実行、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
│ └── ...
└── ...
チャネル固有のメッセージアクションランタイムは、現在 src/agents/tools 配下ではなく、Plugin が所有する extension ディレクトリにあります。例:
- Discord Plugin アクションランタイムファイル
- Slack Plugin アクションランタイムファイル
- Telegram Plugin アクションランタイムファイル
- WhatsApp Plugin アクションランタイムファイル
コア統合フロー
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_endturn_start/turn_endagent_start/agent_endcompaction_start/compaction_end
4. プロンプト送信
セットアップ後、セッションにプロンプトを送信します。
await session.prompt(effectivePrompt, { images: imageResult.images });
SDK は LLM への送信、ツール呼び出しの実行、レスポンスのストリーミングを含む完全なエージェントループを処理します。
画像注入はプロンプトローカルです。OpenClaw は現在のプロンプトから画像参照を読み込み、そのターンだけ images 経由で渡します。古い履歴ターンを再スキャンして画像ペイロードを再注入することはありません。
ツールアーキテクチャ
ツールパイプライン
- ベースツール: pi の
codingTools(read、bash、edit、write) - カスタム置換: OpenClaw は bash を
exec/processに置き換え、サンドボックス向けに read/edit/write をカスタマイズします - OpenClaw ツール: メッセージング、ブラウザー、キャンバス、セッション、cron、gateway など
- チャネルツール: Discord/Telegram/Slack/WhatsApp 固有のアクションツール
- ポリシーフィルタリング: プロファイル、プロバイダー、エージェント、グループ、サンドボックスポリシーによってツールをフィルタリング
- スキーマ正規化: Gemini/OpenAI の癖に合わせてスキーマを整理
- AbortSignal ラップ: abort シグナルを尊重するようにツールをラップ
ツール定義アダプター
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、Docs、Workspace、Sandbox、Messaging、Reply Tags、Voice、Silent Replies、Heartbeats、ランタイムメタデータなどのセクションに加え、有効な場合は 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();
モデル解決
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 に追加します。
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" | ...
Thinking レベルのフォールバック
Thinking レベルがサポートされていない場合は、フォールバックします。
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
- Plugin 所有のツールスキーマのサニタイズ
OpenAI
- Codex モデル向けの
apply_patchツール - Thinking レベルのダウングレード処理
TUI 統合
OpenClaw には、pi-tui コンポーネントを直接使うローカル TUI モードもあります。
// src/tui/tui.ts
これは、pi のネイティブモードに似たインタラクティブなターミナル体験を提供します。
Pi CLI との主な違い
| 観点 | Pi CLI | OpenClaw Embedded |
|---|---|---|
| 呼び出し | pi コマンド / RPC |
createAgentSession() 経由の SDK |
| ツール | デフォルトのコーディングツール | カスタム OpenClaw ツールスイート |
| システムプロンプト | AGENTS.md + プロンプト | チャンネル/コンテキストごとの動的生成 |
| セッション保存 | ~/.pi/agent/sessions/ |
~/.openclaw/agents/<agentId>/sessions/(または $OPENCLAW_STATE_DIR/agents/<agentId>/sessions/) |
| 認証 | 単一の認証情報 | ローテーション付きのマルチプロファイル |
| 拡張 | ディスクから読み込み | プログラム指定 + ディスクパス |
| イベント処理 | TUI レンダリング | コールバックベース(onBlockReply など) |
今後の検討事項
潜在的な再作業領域:
- ツールシグネチャの整合: 現在は pi-agent-core と pi-coding-agent のシグネチャ間で適応している
- セッションマネージャーのラップ:
guardSessionManagerは安全性を追加するが、複雑さも増やす - 拡張読み込み: pi の
ResourceLoaderをより直接的に使える可能性がある - ストリーミングハンドラーの複雑さ:
subscribeEmbeddedPiSessionが大きくなっている - プロバイダーの癖: pi が潜在的に処理できる可能性のある、プロバイダー固有のコードパスが多い
テスト
Pi 統合のカバレッジは、これらのスイートにまたがります。
src/agents/pi-*.test.tssrc/agents/pi-auth-json.test.tssrc/agents/pi-embedded-*.test.tssrc/agents/pi-embedded-helpers*.test.tssrc/agents/pi-embedded-runner*.test.tssrc/agents/pi-embedded-runner/**/*.test.tssrc/agents/pi-embedded-subscribe*.test.tssrc/agents/pi-tools*.test.tssrc/agents/pi-tool-definition-adapter*.test.tssrc/agents/pi-settings.test.tssrc/agents/pi-hooks/**/*.test.ts
ライブ/オプトイン:
src/agents/pi-embedded-runner-extraparams.live.test.ts(OPENCLAW_LIVE_TEST=1を有効化)
現在の実行コマンドについては、Pi 開発ワークフローを参照してください。