OpenProgram Docs

设计文档#

OpenProgram 当前的设计笔记,按子系统分组,与 openprogram/ 下的代码布局保持一致。先读本索引,再读你需要的那篇文档。

每个子目录汇集某一领域的设计。在同一分组内,定义当前实现的文档排在最前;其余是支撑性的笔记 / 调研,不应覆盖前者。

context/ — context 引擎、commit、工具老化#

Doc Topic
context/overview.md Context 层:pipeline + DAG 存储 + ContextCommit + compaction/render + attach/merge + 跨轮工具 + 缺口
context/composition.md 目标状态:按调用分层(L0/L1/L2)+ 情境上下文
context/comparison.md 与参考项目的 context 方案对比
context/context-compaction.html Context 压缩(已渲染)

memory/ — 记忆系统(实体 + 抽象)#

Doc Topic
memory/README.md 记忆系统总览:架构、设计原则、实施状态
memory/overview.md 记忆子系统:实体/抽象两层 + 溯源导航式回忆,以及当前在跑的总结链(可视化
memory/entity-memory.md 实体记忆:Session-Git + Project-Git,按生命周期组织
memory/git-as-entity-memory.md 用 Git 做实体记忆:Session-Git + Project-Git
memory/virtual-memory.md 抽象记忆:Timeline + Graph + Core,按类型 × 生命周期组织

proactive/ — 事件层 + 主动性(事件驱动)#

分两块:事件底座(一条统一事件流,给整个框架用)+ 主动性应用(规则订阅事件流出手)。 两块解耦,可只做底座。先读 event-layer 建立整体认识。

事件底座:

Doc Topic
proactive/event-layer.md 统一 Event 模型 + 框架定位 + 框架图 + 事件边界与演进(已落地:A/B 类事件全在发,gate 可拦可视化
proactive/framework-evolution.md 框架演进:现状 → 目标 → 五步迁移(步 1·2·3 ✅,可视化

主动性应用(建在底座上):

Doc Topic
proactive/overview.md 跟着一个场景走一遍(拦 rm -rf),规则 / 出手 / 状态等概念就地讲
proactive/events-and-state.md 状态怎么从事件累加(fold)出来——规则能"记住过去"的原理
proactive/execution-model.md 规则(Policy)怎么写;挡路的 / 旁观的两类有何不同
proactive/policies-mvp.md 三条样板规则,照着写新规则
proactive/invariants.md 框架自己要守的底线(主要是别绕成死循环)

论文/生产级内容(离线回放验证、对抗安全、评估骨架)已归档在 proactive/_research_archive/,以后做加固再取回。

runtime/ — agent 执行、DAG、异步、回退、可控性#

Doc Topic
runtime/overview.md Runtime API 行为(另见 ../api/runtime.md
runtime/operations/user-input-requests.md runtime.ask/confirm 等用户输入
runtime/controllability-and-three-surface-sync.md 值守/无人值守开关 + 中途干预 + 优雅停 + 三端同步
runtime/p3-three-surface-sync.md P3 三端同步实施细节
runtime/unified-session-context.md 统一 session context
runtime/execution/agent-worktree.md Agent worktree 行为
runtime/execution/async-task-lifecycle.md 异步任务生命周期
runtime/operations/streaming-resume.md 流式 + 恢复
runtime/operations/file-management.md 回退层(commit / worktree)
runtime/operations/multi-agent-revert-todo.md 多 agent 回退 TODO
runtime/dag/overview.md 权威 Session DAG 数据模型(一张图 / 3 种节点 user·llm·code / caller+predecessor 边 / spawn / 渲染 / 装配 / 压缩)
runtime/dag/rendering.md 权威渲染规范:布局/连线/图例/默认可见性,12 场景
runtime/dag/branch-collaboration.md 分支协作(通信 / 派活 / 合并)设计与实现步骤
runtime/execution/dispatcher-split.md Dispatcher 拆分设计
runtime/execution/next-step-decision.md 下一步决策(模型如何选择接下来执行什么)
runtime/execution/agentic-self-recursion.md Agentic 自递归(已渲染
runtime/operations/rewind.md Rewind 回退
runtime/operations/branch-naming.md 分支命名(已渲染
runtime/session/README.md Session 子系统:数据模型、存储、命名、列表、生命周期
runtime/self-update.md 自我更新:一边改自己一边保持可用
runtime/permission-model.md 权限系统设计
runtime/sandbox.md 沙箱:两个平台的边界、开关在哪里丢掉、覆盖面、八个参考框架的对标、修复顺序(图示
runtime/ssrf-protection.html 出站 URL 与 SSRF:当前缺口、Hermes/OpenClaw/OWASP 对照、分 scope 信任策略、transport 要求与完整验收门槛
runtime/agent-collaboration.md Agent 协作:分支间通信原语(工具面八家参考实现对照
runtime/tool-toggle-management.md 工具开关 / 工具集管理设计
runtime/additional-working-directories.md 会话多工作目录设计

providers/ — LLM provider、凭证、模型目录、thinking/effort#

Doc Topic
providers/request-build.md 请求构建流程
providers/models/overview.md 模型目录最终设计
providers/models/thinking-effort.md Thinking / effort 子系统(级别定义、数据流、各 provider wire 格式、UI picker)
providers/models/fast-tier.md Fast(高速)档:两层判定、存储与线路
providers/auth/claude-code-direct-oauth.md claude-code 直连订阅(砍 Meridian)
providers/auth/credential-validation-unification.md 统一凭证校验
providers/auth/unified-auth-storage.md 统一认证存储
providers/auth/unified-account-management.md 统一账号管理 + 轮换
providers/auth/credential-status-redesign.md 凭证状态
providers/auth/api-key-resolution-unification.md API key 解析统一
providers/reliability/error-retry.md 错误 + 重试处理
providers/reliability/error-taxonomy-propagation.md 错误分类 + 传播
providers/reliability/llm-fault-tolerance.md LLM 容错(调研)
providers/reliability/error-and-timeout-mechanism.html 错误 + 超时机制(已渲染)
providers/network-proxy.md 出站网络代理
providers/auth/credential-connection-unification.md 凭证/连接统一
providers/PROBLEM-models-and-bailian.md 模型清单与百炼 provider

function/ — function 与工具调用#

Doc Topic
function/calling-unification.md 工具/函数调用框架(当前)

面向 authoring 的文档(@agentic_function 用法、函数元数据、 工具调用循环、下一步决策、纯 python 辅助)已移至 用户指南 ../agentic-programming/README.md

cli/ — CLI / TUI、斜杠命令、端口#

Doc Topic
cli/redesign.md CLI / TUI 重设计(schema 驱动的设置、配置面板)—— 当前
cli/ports.md Web UI 端口(配置入口、冲突处理)
cli/slash-commands.md 斜杠命令
cli/slash-commands-references.md 斜杠命令参考快照
cli/drop-run-command.md 从 Web UI 触发的函数执行路径
cli/naming.md CLI 命名
cli/single-port.md 单端口架构
cli/config-write-safety.md 配置写入安全——原子 update_config
cli/tui-upgrade.md TUI 升级

channels/ — 消息通道#

Doc Topic
channels/design.md 通道设计(当前)
channels/audit.md 通道审计 / 参考快照

ui/ — surface、指示点、附件、GUI agent#

Doc Topic
ui/invariants.md 跨模块 UI 不变量清单
ui/chat-turn-visual-spec.html 聊天轮次视觉规范(执行时间线 + 手动函数运行 + 消息导航)
ui/interaction-feedback.md 交互反馈 0ms 规则
ui/surface-system.md Surface 系统
ui/indicator-dots.md 指示点
ui/attachment-handling.md 附件处理(已渲染
ui/composer-interaction-modes.md Composer 交互模式
ui/gui-agent-context.md GUI agent 上下文流转
ui/state-layer.md Web 状态层:会话级 vs 全局 store,会话作用域容器方案
ui/project-workspace.md 项目工作区——文件、标签页、多会话(原型

integrations/ — MCP、skills/plugins、harness 标准#

Doc Topic
integrations/harness-standard.md Harness 标准(插件 + 自动探测);安装:../installing-harnesses.md
integrations/mcp-integration.md MCP 集成
integrations/skills-and-plugins.md Skills 与 plugins

extension-gating/#

扩展门控设计 + 参考对比 —— 见 extension-gating/README.md

横切关注点#

Doc Topic
usage-metering.md Usage 子系统(token/cost 记账、ledger、收口点、子进程、消费层)
framework-overview.md 框架总览:一次对话从输入到产出
framework-comparison.html 整框架对标:按设计维度和十二家横向比,强在哪、弱在哪、别人有什么我们没想到(图解)
feature-matrix.html 功能清单对标:同样十二家改按功能清单扫,160 项一张大表,只有别人有的、只有我们有的(图解)
docs-site.md 文档站本身(构建、导航、双语路由)

research/ — 调研#

Doc Topic
research/execution-trace-model-selection.md Agent 执行轨迹的数据模型选型(span 概念、创新点)

plans/ — 带日期的实施计划#

Doc Topic
plans/proactive-implementation.md 主动性层实施计划
plans/cache-control-passthrough.md Anthropic cache_control 逐块透传(已落地)
plans/2026-07-08-credential-connection-unification.md 凭证/连接统一迁移

已删除的文档#

不存在 archive/ 目录:被取代的文档是直接删除的,需要时从 git 历史找回。

历史上删除过:

  • model-catalog-dynamic.md / model-catalog-per-provider.md — 迭代草稿,被 models.md 取代
  • claude-code-meridian-profile.md — Meridian proxy 已砍,纯历史
  • *-references.md — 调研快照/原始研究笔记(slash-commands / tui-upgrade / user-input-requests)

TODO-doc-code-gaps.md#

TODO-doc-code-gaps.md — 文档与代码不一致的待修项,按优先级排列。修完一条删一条。

约定#

  • 每个子系统一个子目录,与 openprogram/ 对应。新设计文档放进匹配的分组, 而不是扁平的根目录。当某个主题增长到超过几个文件时,新建一个分组。
  • 每个分组先列当前的来源;支撑性笔记随后。
  • API 参考归在 docs/api/ 下;设计依据归在这里。
  • 函数 authoring 规则以 ../agentic-programming/writing-functions/function-metadata.md 为 准——较短的文件链接到它,而不是重复其内容。
  • 装饰器字段为 render_range={"callers": N, "subcalls": M} —— callers 按 seq 限制帧前节点数,subcalls 按 seq 限制帧内节点数。 代码和文档都仅使用这两个名字。
Last updated · 2026-08-13