Pi 集成架构
本文档描述了 Mayros 如何与 pi-coding-agent 及其同级包(pi-ai、pi-agent-core、pi-tui)集成以支持其 AI 代理功能。
概述
Mayros 使用 pi SDK 将 AI 编码代理嵌入到其消息网关架构中。Mayros 不是将 pi 作为子进程生成或使用 RPC 模式,而是直接导入并通过 createAgentSession() 实例化 pi 的 AgentSession。这种嵌入式方法提供:
- 对会话生命周期和事件处理的完全控制
- 自定义工具注入(消息、沙箱、渠道特定操作)
- 每个渠道/上下文的系统提示自定义
- 带分支/压缩支持的会话持久性
- 具有故障转移的多账户身份验证配置文件轮换
- 提供商无关的模型切换
包依赖项
json{ "@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-core | 代理循环、工具执行、AgentMessage 类型 |
pi-coding-agent | 高级 SDK:createAgentSession、SessionManager、AuthStorage、ModelRegistry、内置工具 |
pi-tui | 终端 UI 组件(在 Mayros 的本地 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 vs 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 # createMayrosCodingTools()
├── pi-tools.abort.ts # 工具的 AbortSignal 包装
├── pi-tools.policy.ts # 工具允许列表/拒绝列表策略
├── pi-tools.read.ts # 读取工具自定义
├── pi-tools.schema.ts # 工具模式规范化
├── 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 # 渠道特定工具注入
├── mayros-tools.ts # Mayros 特定工具
├── 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. 运行嵌入式代理
主入口点是 pi-embedded-runner/run.ts 中的 runEmbeddedPiAgent():
typescriptimport { 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: mayrosConfig, 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:
typescriptimport { 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 事件:
typescriptconst 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_endauto_compaction_start/auto_compaction_end
4. 提示
设置后,提示会话:
typescriptawait session.prompt(effectivePrompt, { images: imageResult.images });
SDK 处理完整的代理循环:发送到 LLM、执行工具调用、流式响应。
工具架构
工具管道
- 基本工具:pi 的
codingTools(read、bash、edit、write) - 自定义替换:Mayros 用
exec/process替换 bash,为沙箱自定义 read/edit/write - Mayros 工具:messaging、browser、canvas、sessions、cron、gateway 等
- 渠道工具:Discord/Telegram/Slack/WhatsApp 特定操作工具
- 策略过滤:按配置文件、提供商、代理、组、沙箱策略过滤工具
- 模式规范化:为 Gemini/OpenAI 怪癖清理模式
- AbortSignal 包装:包装工具以遵守中止信号
工具定义适配器
pi-agent-core 的 AgentTool 与 pi-coding-agent 的 ToolDefinition 具有不同的 execute 签名。pi-tool-definition-adapter.ts 中的适配器桥接了这一点:
typescriptexport 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 传递所有工具:
typescriptexport function splitSdkTools(options: { tools: AnyAgentTool[]; sandboxEnabled: boolean }) { return { builtInTools: [], // 空。我们覆盖所有内容 customTools: toToolDefinitions(options.tools), }; }
这确保了 Mayros 的策略过滤、沙箱集成和扩展工具集在各个提供商之间保持一致。
系统提示构建
系统提示在 buildAgentSystemPrompt()(system-prompt.ts)中构建。它组装了一个完整的提示,包括工具、工具调用样式、安全防护、Mayros CLI 参考、技能、文档、工作区、沙箱、消息、回复标签、语音、静默回复、心跳、运行时元数据,以及启用时的内存和反应,以及可选的上下文文件和额外的系统提示内容等部分。对于子代理使用的最小提示模式,部分被修剪。
设置后通过 applySystemPromptOverrideToSession() 应用提示:
typescriptconst systemPromptOverride = createSystemPromptOverride(appendPrompt); applySystemPromptOverrideToSession(session, systemPromptOverride);
会话管理
会话文件
会话是具有树结构(id/parentId 链接)的 JSONL 文件。Pi 的 SessionManager 处理持久性:
typescriptconst sessionManager = SessionManager.open(params.sessionFile);
Mayros 用 guardSessionManager() 包装它以确保工具结果安全。
会话缓存
session-manager-cache.ts 缓存 SessionManager 实例以避免重复的文件解析:
typescriptawait prewarmSessionFile(params.sessionFile); sessionManager = SessionManager.open(params.sessionFile); trackSessionManagerAccess(params.sessionFile);
历史限制
limitHistoryTurns() 根据渠道类型(DM vs 群组)修剪对话历史。
压缩
自动压缩在上下文溢出时触发。compactEmbeddedPiSessionDirect() 处理手动压缩:
typescriptconst compactResult = await compactEmbeddedPiSessionDirect({ sessionId, sessionFile, provider, model, ... });
身份验证和模型解析
身份验证配置文件
Mayros 维护每个提供商具有多个 API 密钥的身份验证配置文件存储:
typescriptconst authStore = ensureAuthProfileStore(agentDir, { allowKeychainPrompt: false }); const profileOrder = resolveAuthProfileOrder({ cfg, store: authStore, provider, preferredProfile });
配置文件在失败时轮换,并进行冷却跟踪:
typescriptawait markAuthProfileFailure({ store, profileId, reason, cfg, agentDir }); const rotated = await advanceAuthProfile();
模型解析
typescriptimport { 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 在配置时触发模型回退:
typescriptif (fallbackConfigured && isFailoverErrorMessage(errorText)) { throw new FailoverError(errorText, { reason: promptFailoverReason ?? "unknown", provider, model: modelId, profileId, status: resolveFailoverStatus(promptFailoverReason), }); }
Pi 扩展
Mayros 加载自定义 pi 扩展以实现专门的行为:
压缩保护
pi-extensions/compaction-safeguard.ts 为压缩添加防护,包括自适应令牌预算加上工具失败和文件操作摘要:
typescriptif (resolveCompactionMode(params.cfg) === "safeguard") { setCompactionSafeguardRuntime(params.sessionManager, { maxHistoryShare }); paths.push(resolvePiExtensionPath("compaction-safeguard")); }
上下文修剪
pi-extensions/context-pruning.ts 实现基于缓存 TTL 的上下文修剪:
typescriptif (cfg?.agents?.defaults?.contextPruning?.mode === "cache-ttl") { setContextPruningRuntime(params.sessionManager, { settings, contextWindowTokens, isToolPrunable, lastCacheTouchAt, }); paths.push(resolvePiExtensionPath("context-pruning")); }
流式传输和块回复
块分块
EmbeddedBlockChunker 管理将流式文本分成离散的回复块:
typescriptconst blockChunker = blockChunking ? new EmbeddedBlockChunker(blockChunking) : null;
Thinking/Final 标签剥离
流式输出被处理以剥离 <think>/<thinking> 块并提取 <final> 内容:
typescriptconst stripBlockTags = (text: string, state: { thinking: boolean; final: boolean }) => { // 剥离 <think>...</think> 内容 // 如果 enforceFinalTag,仅返回 <final>...</final> 内容 };
回复指令
解析和提取 [[media:url]]、[[voice]]、[[reply:id]] 等回复指令:
typescriptconst { text: cleanedText, mediaUrls, audioAsVoice, replyToId } = consumeReplyDirectives(chunk);
错误处理
错误分类
pi-embedded-helpers.ts 对错误进行分类以进行适当处理:
typescriptisContextOverflowError(errorText) // 上下文太大 isCompactionFailureError(errorText) // 压缩失败 isAuthAssistantError(lastAssistant) // 身份验证失败 isRateLimitAssistantError(...) // 速率受限 isFailoverAssistantError(...) // 应该故障转移 classifyFailoverReason(errorText) // "auth" | "rate_limit" | "quota" | "timeout" | ...
思考级别回退
如果不支持思考级别,它会回退:
typescriptconst fallbackThinking = pickFallbackThinkingLevel({ message: errorText, attempted: attemptedThinking, }); if (fallbackThinking) { thinkLevel = fallbackThinking; continue; }
沙箱集成
启用沙箱模式时,工具和路径受到约束:
typescriptconst sandbox = await resolveSandboxContext({ config: params.config, sessionKey: sandboxSessionKey, workspaceDir: resolvedWorkspace, }); if (sandboxRoot) { // 使用沙箱化的 read/edit/write 工具 // Exec 在容器中运行 // Browser 使用桥接 URL }
提供商特定处理
Anthropic
- 拒绝魔术字符串清理
- 连续角色的回合验证
- Claude Code 参数兼容性
Google/Gemini
- 回合排序修复(
applyGoogleTurnOrderingFix) - 工具模式清理(
sanitizeToolsForGoogle) - 会话历史清理(
sanitizeSessionHistory)
OpenAI
- Codex 模型的
apply_patch工具 - 思考级别降级处理
TUI 集成
Mayros 还有一个本地 TUI 模式,直接使用 pi-tui 组件:
typescript// src/tui/tui.ts import { ... } from "@mariozechner/pi-tui";
这提供了类似于 pi 原生模式的交互式终端体验。
与 Pi CLI 的主要区别
| 方面 | Pi CLI | Mayros 嵌入式 |
|---|---|---|
| 调用 | pi 命令 / RPC | 通过 createAgentSession() 的 SDK |
| 工具 | 默认编码工具 | 自定义 Mayros 工具套件 |
| 系统提示 | AGENTS.md + prompts | 每个渠道/上下文的动态 |
| 会话存储 | ~/.pi/agent/sessions/ | ~/.mayros/agents/<agentId>/sessions/(或 $MAYROS_STATE_DIR/agents/<agentId>/sessions/) |
| 身份验证 | 单个凭据 | 具有轮换的多配置文件 |
| 扩展 | 从磁盘加载 | 编程 + 磁盘路径 |
| 事件处理 | TUI 渲染 | 基于回调(onBlockReply 等) |
未来考虑
可能需要重新设计的领域:
- 工具签名对齐:当前在 pi-agent-core 和 pi-coding-agent 签名之间进行适配
- 会话管理器包装:
guardSessionManager增加了安全性但增加了复杂性 - 扩展加载:可以更直接地使用 pi 的
ResourceLoader - 流式处理程序复杂性:
subscribeEmbeddedPiSession变得很大 - 提供商怪癖:许多提供商特定的代码路径,pi 可能可以处理
测试
涵盖 pi 集成及其扩展的所有现有测试:
src/agents/pi-embedded-block-chunker.test.tssrc/agents/pi-embedded-helpers.buildbootstrapcontextfiles.test.tssrc/agents/pi-embedded-helpers.classifyfailoverreason.test.tssrc/agents/pi-embedded-helpers.downgradeopenai-reasoning.test.tssrc/agents/pi-embedded-helpers.formatassistanterrortext.test.tssrc/agents/pi-embedded-helpers.formatrawassistanterrorforui.test.tssrc/agents/pi-embedded-helpers.image-dimension-error.test.tssrc/agents/pi-embedded-helpers.image-size-error.test.tssrc/agents/pi-embedded-helpers.isautherrormessage.test.tssrc/agents/pi-embedded-helpers.isbillingerrormessage.test.tssrc/agents/pi-embedded-helpers.iscloudcodeassistformaterror.test.tssrc/agents/pi-embedded-helpers.iscompactionfailureerror.test.tssrc/agents/pi-embedded-helpers.iscontextoverflowerror.test.tssrc/agents/pi-embedded-helpers.isfailovererrormessage.test.tssrc/agents/pi-embedded-helpers.islikelycontextoverflowerror.test.tssrc/agents/pi-embedded-helpers.ismessagingtoolduplicate.test.tssrc/agents/pi-embedded-helpers.messaging-duplicate.test.tssrc/agents/pi-embedded-helpers.normalizetextforcomparison.test.tssrc/agents/pi-embedded-helpers.resolvebootstrapmaxchars.test.tssrc/agents/pi-embedded-helpers.sanitize-session-messages-images.keeps-tool-call-tool-result-ids-unchanged.test.tssrc/agents/pi-embedded-helpers.sanitize-session-messages-images.removes-empty-assistant-text-blocks-but-preserves.test.tssrc/agents/pi-embedded-helpers.sanitizegoogleturnordering.test.tssrc/agents/pi-embedded-helpers.sanitizesessionmessagesimages-thought-signature-stripping.test.tssrc/agents/pi-embedded-helpers.sanitizetoolcallid.test.tssrc/agents/pi-embedded-helpers.sanitizeuserfacingtext.test.tssrc/agents/pi-embedded-helpers.stripthoughtsignatures.test.tssrc/agents/pi-embedded-helpers.validate-turns.test.tssrc/agents/pi-embedded-runner-extraparams.live.test.ts(实时)src/agents/pi-embedded-runner-extraparams.test.tssrc/agents/pi-embedded-runner.applygoogleturnorderingfix.test.tssrc/agents/pi-embedded-runner.buildembeddedsandboxinfo.test.tssrc/agents/pi-embedded-runner.createsystempromptoverride.test.tssrc/agents/pi-embedded-runner.get-dm-history-limit-from-session-key.falls-back-provider-default-per-dm-not.test.tssrc/agents/pi-embedded-runner.get-dm-history-limit-from-session-key.returns-undefined-sessionkey-is-undefined.test.tssrc/agents/pi-embedded-runner.google-sanitize-thinking.test.tssrc/agents/pi-embedded-runner.guard.test.tssrc/agents/pi-embedded-runner.limithistoryturns.test.tssrc/agents/pi-embedded-runner.resolvesessionagentids.test.tssrc/agents/pi-embedded-runner.run-embedded-pi-agent.auth-profile-rotation.test.tssrc/agents/pi-embedded-runner.sanitize-session-history.test.tssrc/agents/pi-embedded-runner.splitsdktools.test.tssrc/agents/pi-embedded-runner.test.tssrc/agents/pi-embedded-subscribe.code-span-awareness.test.tssrc/agents/pi-embedded-subscribe.reply-tags.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.calls-onblockreplyflush-before-tool-execution-start-preserve.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-append-text-end-content-is.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-call-onblockreplyflush-callback-is-not.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-duplicate-text-end-repeats-full.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.does-not-emit-duplicate-block-replies-text.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.emits-block-replies-text-end-does-not.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.emits-reasoning-as-separate-message-enabled.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.filters-final-suppresses-output-without-start-tag.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.includes-canvas-action-metadata-tool-summaries.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.keeps-assistanttexts-final-answer-block-replies-are.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.keeps-indented-fenced-blocks-intact.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.reopens-fenced-blocks-splitting-inside-them.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.splits-long-single-line-fenced-blocks-reopen.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.streams-soft-chunks-paragraph-preference.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.subscribeembeddedpisession.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.suppresses-message-end-block-replies-message-tool.test.tssrc/agents/pi-embedded-subscribe.subscribe-embedded-pi-session.waits-multiple-compaction-retries-before-resolving.test.tssrc/agents/pi-embedded-subscribe.tools.test.tssrc/agents/pi-embedded-utils.test.tssrc/agents/pi-extensions/compaction-safeguard.test.tssrc/agents/pi-extensions/context-pruning.test.tssrc/agents/pi-settings.test.tssrc/agents/pi-tool-definition-adapter.test.tssrc/agents/pi-tools-agent-config.test.tssrc/agents/pi-tools.create-mayros-coding-tools.adds-claude-style-aliases-schemas-without-dropping-b.test.tssrc/agents/pi-tools.create-mayros-coding-tools.adds-claude-style-aliases-schemas-without-dropping-d.test.tssrc/agents/pi-tools.create-mayros-coding-tools.adds-claude-style-aliases-schemas-without-dropping-f.test.tssrc/agents/pi-tools.create-mayros-coding-tools.adds-claude-style-aliases-schemas-without-dropping.test.tssrc/agents/pi-tools.policy.test.tssrc/agents/pi-tools.safe-bins.test.tssrc/agents/pi-tools.workspace-paths.test.ts