Technical reference

Архітектура інтеграції Pi

Edit source

OpenClaw інтегрується з pi-coding-agent та спорідненими пакетами (pi-ai, pi-agent-core, pi-tui), щоб забезпечувати можливості AI-агента.

Огляд

OpenClaw використовує pi SDK, щоб вбудувати AI-агента для кодування в архітектуру Gateway для повідомлень. Замість запуску pi як підпроцесу або використання режиму RPC, OpenClaw напряму імпортує й інстанціює AgentSession з pi через createAgentSession(). Такий вбудований підхід забезпечує:

  • Повний контроль над життєвим циклом сеансу та обробкою подій
  • Ін’єкцію власних інструментів (повідомлення, пісочниця, дії для конкретних каналів)
  • Налаштування системного промпта для кожного каналу/контексту
  • Збереження сеансів із підтримкою гілкування/Compaction
  • Ротацію профілів автентифікації для кількох облікових записів із відмовостійким перемиканням
  • Перемикання моделей незалежно від провайдера

Залежності пакетів

json
{  "@earendil-works/pi-agent-core": "0.74.0",  "@earendil-works/pi-ai": "0.74.0",  "@earendil-works/pi-coding-agent": "0.74.0",  "@earendil-works/pi-tui": "0.74.0"}
Пакет Призначення
pi-ai Основні абстракції LLM: Model, streamSimple, типи повідомлень, API провайдерів
pi-agent-core Цикл агента, виконання інструментів, типи AgentMessage
pi-coding-agent Високорівневий SDK: createAgentSession, SessionManager, AuthStorage, ModelRegistry, вбудовані інструменти
pi-tui Компоненти термінального інтерфейсу (використовуються в локальному режимі TUI OpenClaw)

Структура файлів

Code
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-власних розширень, а не в src/agents/tools, наприклад:

  • файли середовища виконання дій Plugin Discord
  • файл середовища виконання дій Plugin Slack
  • файл середовища виконання дій Plugin Telegram
  • файл середовища виконання дій Plugin WhatsApp

Основний потік інтеграції

1. Запуск вбудованого агента

Основна точка входу — runEmbeddedPiAgent() у pi-embedded-runner/run.ts:

typescript
 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:

typescript
   createAgentSession,  DefaultResourceLoader,  SessionManager,  SettingsManager,} from "@earendil-works/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() підписується на події AgentSession з pi:

typescript
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. Промптинг

Після налаштування до сеансу надсилається промпт:

typescript
await session.prompt(effectivePrompt, { images: imageResult.images });

SDK обробляє повний цикл агента: надсилання до LLM, виконання викликів інструментів, потокове передавання відповідей.

Ін’єкція зображень локальна для промпта: OpenClaw завантажує посилання на зображення з поточного промпта й передає їх через images лише для цього ходу. Він не сканує повторно старіші ходи історії, щоб повторно ін’єктувати payload-и зображень.

Архітектура інструментів

Конвеєр інструментів

  1. Базові інструменти: codingTools з pi (read, bash, edit, write)
  2. Власні заміни: OpenClaw замінює bash на exec/process, налаштовує read/edit/write для пісочниці
  3. Інструменти OpenClaw: повідомлення, браузер, canvas, сеанси, Cron, Gateway тощо.
  4. Інструменти каналів: інструменти дій, специфічні для Discord/Telegram/Slack/WhatsApp
  5. Фільтрація політик: інструменти фільтруються за політиками профілю, провайдера, агента, групи та пісочниці
  6. Нормалізація схем: схеми очищуються з урахуванням особливостей Gemini/OpenAI
  7. Обгортання AbortSignal: інструменти обгортаються, щоб поважати сигнали переривання

Адаптер визначення інструментів

AgentTool з pi-agent-core має іншу сигнатуру execute, ніж ToolDefinition з pi-coding-agent. Адаптер у pi-tool-definition-adapter.ts поєднує їх:

typescript
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:

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

Це гарантує, що фільтрація політик OpenClaw, інтеграція із sandbox і розширений набір інструментів залишаються узгодженими між провайдерами.

Побудова системного prompt

Системний prompt створюється у buildAgentSystemPrompt() (system-prompt.ts). Він збирає повний prompt із розділами, зокрема Tooling, Tool Call Style, Safety guardrails, OpenClaw Control, Skills, Docs, Workspace, Sandbox, Messaging, Assistant Output Directives, Voice, Silent Replies, Heartbeats, Runtime metadata, а також Memory і Reactions, коли їх увімкнено, і необов’язковими контекстними файлами та додатковим вмістом системного prompt. Розділи скорочуються для мінімального режиму prompt, який використовується subagents.

Prompt застосовується після створення сесії через applySystemPromptOverrideToSession():

typescript
const systemPromptOverride = createSystemPromptOverride(appendPrompt);applySystemPromptOverrideToSession(session, systemPromptOverride);

Керування сесіями

Файли сесій

Сесії — це файли JSONL із деревоподібною структурою (зв’язування id/parentId). SessionManager Pi відповідає за збереження:

typescript
const sessionManager = SessionManager.open(params.sessionFile);

OpenClaw обгортає це через guardSessionManager() для безпеки результатів інструментів.

Кешування сесій

session-manager-cache.ts кешує екземпляри SessionManager, щоб уникнути повторного розбору файлів:

typescript
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:

typescript
const compactResult = await compactEmbeddedPiSessionDirect({  sessionId, sessionFile, provider, model, ...});

Автентифікація та визначення моделі

Профілі автентифікації

OpenClaw підтримує сховище профілів автентифікації з кількома API-ключами для кожного провайдера:

typescript
const authStore = ensureAuthProfileStore(agentDir, { allowKeychainPrompt: false });const profileOrder = resolveAuthProfileOrder({ cfg, store: authStore, provider, preferredProfile });

Профілі змінюються після збоїв із відстеженням періоду очікування:

typescript
await markAuthProfileFailure({ store, profileId, reason, cfg, agentDir });const rotated = await advanceAuthProfile();

Визначення моделі

typescript
 const { model, error, authStorage, modelRegistry } = resolveModel(  provider,  modelId,  agentDir,  config,); // Uses pi's ModelRegistry and AuthStorageauthStorage.setRuntimeApiKey(model.provider, apiKeyInfo.apiKey);

Відмовостійке перемикання

FailoverError запускає fallback моделі, коли його налаштовано:

typescript
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, зокрема адаптивний бюджет токенів, а також підсумки збоїв інструментів і файлових операцій:

typescript
if (resolveCompactionMode(params.cfg) === "safeguard") {  setCompactionSafeguardRuntime(params.sessionManager, { maxHistoryShare });  paths.push(resolvePiExtensionPath("compaction-safeguard"));}

Обрізання контексту

src/agents/pi-hooks/context-pruning.ts реалізує обрізання контексту на основі cache-TTL:

typescript
if (cfg?.agents?.defaults?.contextPruning?.mode === "cache-ttl") {  setContextPruningRuntime(params.sessionManager, {    settings,    contextWindowTokens,    isToolPrunable,    lastCacheTouchAt,  });  paths.push(resolvePiExtensionPath("context-pruning"));}

Стримінг і блокові відповіді

Розбиття на блоки

EmbeddedBlockChunker керує стримінгом тексту в окремі блоки відповіді:

typescript
const blockChunker = blockChunking ? new EmbeddedBlockChunker(blockChunking) : null;

Видалення тегів мислення/фінальної відповіді

Стримінговий вивід обробляється, щоб видалити блоки <think>/<thinking> і витягти вміст <final>:

typescript
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]], розбираються та витягуються:

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

Обробка помилок

Класифікація помилок

pi-embedded-helpers.ts класифікує помилки для відповідної обробки:

typescript
isContextOverflowError(errorText)     // Context too largeisCompactionFailureError(errorText)   // Compaction failedisAuthAssistantError(lastAssistant)   // Auth failureisRateLimitAssistantError(...)        // Rate limitedisFailoverAssistantError(...)         // Should failoverclassifyFailoverReason(errorText)     // "auth" | "rate_limit" | "quota" | "timeout" | ...

Fallback рівня мислення

Якщо рівень мислення не підтримується, він переходить на fallback:

typescript
const fallbackThinking = pickFallbackThinkingLevel({  message: errorText,  attempted: attemptedThinking,});if (fallbackThinking) {  thinkLevel = fallbackThinking;  continue;}

Інтеграція із Sandbox

Коли режим sandbox увімкнено, інструменти та шляхи обмежуються:

typescript
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

  • Очищення магічного рядка відмови
  • Валідація ходів для послідовних ролей
  • Сувора валідація параметрів upstream-інструментів Pi

Google/Gemini

  • Санітизація схеми інструментів, що належать Plugin

OpenAI

  • Інструмент apply_patch для моделей Codex
  • Обробка зниження рівня мислення

Інтеграція TUI

OpenClaw також має локальний режим TUI, який безпосередньо використовує компоненти pi-tui:

typescript
// src/tui/tui.ts 

Це забезпечує інтерактивний термінальний досвід, подібний до нативного режиму pi.

Ключові відмінності від Pi CLI

Аспект Pi CLI Вбудований OpenClaw
Виклик команда pi / RPC SDK через createAgentSession()
Інструменти Типові інструменти для кодування Власний набір інструментів OpenClaw
Системний prompt 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. Завантаження розширень: можна безпосередніше використовувати ResourceLoader Pi
  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

Live/додатково ввімкнені:

  • src/agents/pi-embedded-runner-extraparams.live.test.ts (увімкніть OPENCLAW_LIVE_TEST=1)

Поточні команди запуску див. у робочому процесі розробки Pi.

Пов’язане

Was this useful?