Files

T

ZiyaZhang 8ea5cdd894 docs(i18n): re-translate RFC batch with the prompt-v4 pipeline

146 篇 RFC 译文按 v4 基线（#348）重出：v4 模板+术语表、金标
few-shot、三段协议、切换行后处理；全量机械核对零异常（一处
task id 术语违规已修）。三篇超长 RFC（code-mode 已入，web-seam/
agent-scope/sandbox/cds-core 仍在长文档通道产出）随后补。

2026-07-22 03:07:36 -07:00

5.9 KiB

Raw Blame History

RFC：生成式工具 schema 目录（启动并采集）

English | 中文

Status: implemented

问题

仓库此前没有一份统一的参考文档来记录实际暴露给模型的工具名称、描述与 JSON Schema。源码声明分散各处且在运行时组合，而既有的 Cordis 目录和数据结构目录覆盖的是接线与词汇，而非工具。

决策

通过启动每个工具插件并读取其注册的 schema 来生成目录，而非解析源码。scripts/gen-tool-catalog.ts 将每个已发布的工具包（package）挂载到一个新的 Cordis Context（带 SystemPrompt + ToolRegistry 以及插件 apply 所读取的注入 seam），调用 ctx.tools.schemas()（即发送给模型的 ToolSchema[]），dispose（资源释放）该 context，然后为每个包渲染一个 ## <package> 小节，每个工具一个 ```json 的 parameters 块。它与 gen-cordis-catalog / gen-module-graph 的 CLI（命令行界面）形态一致：默认 --write 重新生成，--check 在已提交副本陈旧时失败，输出是确定性的（按 manifest（元数据清单）排序，工具按名称排序）。verify-tool-catalog（即 --check）在 doc-sync（文档同步门禁）内运行，因此新鲜度门禁在 lefthook pre-push 和 CI 路径中与其他文档门禁一同触发。

为何启动而非解析（核心要点）

Cordis 目录是纯 TypeScript AST 遍历，因为每个事件/服务名都是字符串字面量，可以往返映射到静态声明——AST 即全部事实。工具 schema 在静态层面不可知，因此同样的技术会产出一份说谎的文档：

tool-todo 写了 enum: [...STATUSES]——对一个运行时 const 的展开。AST 看到的是展开表达式，而非 ["pending","in_progress","completed"]。
每条 description 都通过字符串拼接构建（'…' + '…'）。AST 看到的是拼接节点，而非模型实际读到的最终文本。
tool-subagent 的工具名是 config.toolName ?? 'subagent'——加载时选定，并非字面量。
MCP 插件可以通过 ctx.tools.register() 直接注册原始 JSON Schema，完全不经过 defineTool，因此结构化枚举 defineTool( 调用点会遗漏。

唯一忠实的真源是插件加载后注册表实际持有的 schema。启动是测试策略中「验证世界，而非自我报告」这一原则在文档生成器上的应用：读取已发布的产物，而非对它的再推导。

恢复「不会静默遗漏」的保证

启动有一项 AST 遍历不存在的代价：没有源码声明集合可供枚举，新工具包可能被遗忘。一个完整性守卫恢复了这项保证——assertManifestComplete 对 packages/ 下所有 tool-* 包进行 glob，若有任何一个不在生成器的启动 manifest 中则直接报错。新工具包在注册之前会导致生成器失败，进而导致 doc-sync 失败。这与 Cordis 生成器通过枚举源码免费获得的结构性属性相同，只是为基于启动的生成器重新实现了一遍。

手动维护的启动 manifest 是不可化约的策略

文件系统负责发现工具包清单，完整性守卫负责拒绝遗漏。TOOL_PACKAGES 仍然为每个包持有一份显式的启动配方，因为所需的 seam 实现和配置属于策略，不是能从目录布局或注入名称安全推断的事实。

范围

packages/*/tool-* 下已发布的产品工具包，每个以默认配置启动：dsh-tool-bash（bash、bash_output、bash_kill）、dsh-tool-todo（todo_write）、dsh-tool-subagent（subagent）。examples/ 下的演示工具（echo）被排除，与 Cordis 目录仅覆盖 packages 的范围一致——演示工具不属于读者所查阅的产品接口。

目录的单位是包，而非每个配置化的工具实例。每个包以默认配置启动一次；加载时的别名（如 subagent_fork）会注明，但不枚举所有部署排列。部署清单是一个独立的、无界的接口。

使用普通 `json` 围栏

schema 块使用 ```json，而非自定义的 ts 系围栏。doc-typecheck 只提取 ts* 围栏，因此 JSON 块对它不可见——无需 BlockKind 接线（不同于 Cordis 目录的 ts cordis-catalog 围栏，后者需要加入白名单以避免裸签名片段被编译）。

曾考虑的替代方案

纯 TypeScript AST 遍历，如 Cordis 目录：工具 schema 在静态层面不可知（见上文核心要点）：运行时展开、字符串拼接、配置选定的名称，以及原始 ctx.tools.register() 注册，都会让 AST 推导出的文档说谎。
从各包的 inject 推断启动配方：属于发现包清单提案所警告的「过度聪明」路径；配方保持为手写策略，清单由文件系统发现并由完整性守卫把关。
为 schema 块使用自定义 ts 系围栏：不必要。普通 ```json 围栏对 doc-typecheck 不可见，无需 BlockKind 白名单。

后果

目录不会漂移：工具 schema 变更而已提交文件未反映，verify-tool-catalog 会在 pre-push 钩子和 CI 中失败。新 tool-* 包未加入 manifest 则完整性守卫直接报错。
工具描述文本有唯一归属——源码中 defineTool 的 description——生成的条目质量取决于它，与 Cordis 目录对事件 JSDoc 施加的强制力相同。
生成器导入并执行工作区包（这是仓库中第一个这样做的脚本；其他脚本只读文本）。它通过根 tsconfig 的 paths 映射在 tsx 下运行，使用与演示和测试相同的未构建源码路径，因此不需要构建步骤。
未来某个工具背后新增一个能力 seam，意味着 manifest 中需要新增一条配方条目（声明要挂载哪些 seam）。这正是上文指出的有意为之的手写成本；仅在新增工具包时才需变更。

5.9 KiB Raw Blame History Unescape Escape