本目录是面向客户端的运行时契约(Runtime Contracts)权威来源。
这些文档定义了由运行时、CLI、当前 Web 客户端以及后续 TUI 实现共享的 MVP 契约层。
它们对以下内容具有规范性:
- 运行时事件词汇表
- 面向客户端的 session/run/stream API 形状
- 审批请求与处理语义
- 运行时配置界面及优先级
- 客户端预期的流传输行为
这些文件不定义:
- 每个运行时模块的具体实现细节
- post-MVP 的多智能体协议
- UI 布局或视觉设计决策
- GitHub 积压工作的归属或调度
runtime-events.md— 用于客户端渲染的稳定事件词汇表client-api.md— 客户端可见的 session/run/load/resume/stream 契约approval-flow.md— 受控执行与审批语义agent-tool-calling.md— 面向 agent 的工具调用、参数、返回、审批与选择指南agent-tool-enforcement.md— agent preset 中 tool allowlist/default tool set 如何进入 runtime enforcementagent-hook-presets.md— agent preset hook refs 如何通过 builtin hook preset catalog 校验与表达角色 intentagent-capability-bindings.md— agent preset 的 tools/skills/hooks/MCP/provider binding 如何由 runtime materialize 成可重放 snapshotworkflow-presets.md— workflow mode / legacy workflow preset 的 MVP 语义、优先级、快照和非目标runtime-config.md— MVP 配置界面及优先级runtime-extension-points.md— typed runtime extension points 与 observability events 的所有权边界runtime-lifecycle-hooks.md— richer lifecycle hook phases 的 runtime-owned 执行契约background-task-delegation.md— delegated/background task parent/child linkage、结果读取、retry/cancel 与 fake-provider/fake-MCP 验证立场stream-transport.md— 运行时流的交付与重放预期
- #13 运行时事件模式(Schema)
- #14 面向客户端的 API 契约
- #15 审批模式
- #16 运行时配置界面
- #17 流传输抽象
- #163 面向 agent 的工具调用契约与使用说明
- #174 从 runtime 发出
runtime.background_task_waiting_approval - #175 在 runtime 中稳定
RuntimeRequest.metadataschema - #169 runtime enforcement of agent tool allowlists/default tool sets
- #170 richer runtime lifecycle hook execution
- #289 delegated child execution E2E baseline
- #379 builtin hook preset catalog
src/voidcode/runtime/contracts.pysrc/voidcode/runtime/events.pysrc/voidcode/runtime/session.pysrc/voidcode/runtime/service.pysrc/voidcode/hook/presets.pysrc/voidcode/graph/contracts.pysrc/voidcode/tools/contracts.pysrc/voidcode/cli/
- 将模式(Schema)详情放在此处,而不是
README.md、docs/roadmap.md或docs/current-state.md中。 docs/current-state.md应描述现状,然后链接到此处查看契约定义。docs/roadmap.md应仅描述阶段/史诗任务,然后链接到此处查看契约前提条件。- GitHub Issue 应指向这些文件,而不是在 Issue 正文中重复说明完整的模式。