gen-tool-catalog.ts 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. /**
  2. * Generate `docs/tool-catalog.md` from schemas collected by booting each tool
  3. * plugin. Runtime registration is the source of truth for computed schemas;
  4. * the manifest is checked against every on-disk `tool-*` package. `--check`
  5. * verifies the committed artifact. Rationale and ownership live in
  6. * `.agents/notes/implemented/process/2026-07-02-tool-schema-catalog.md`.
  7. */
  8. import { globSync, readFileSync, writeFileSync } from 'node:fs'
  9. import { basename, resolve } from 'node:path'
  10. import { Context } from 'cordis'
  11. import type { ToolSchema } from '@deepseek-ai/dsh-llm'
  12. import AgentRegistry from '@deepseek-ai/dsh-agent'
  13. import GoalService from '@deepseek-ai/dsh-goal'
  14. import SystemPrompt from '@deepseek-ai/dsh-system-prompt'
  15. import ToolRegistry, { type Config as ToolsConfig } from '@deepseek-ai/dsh-tools'
  16. import { BashExecutor } from '@deepseek-ai/dsh-bash'
  17. import type { BashExecRequest, BashExecSpec, BashProcess, BashRunResult } from '@deepseek-ai/dsh-bash'
  18. import LocalBashExecutor from '@deepseek-ai/dsh-bash-local'
  19. import LocalFileSystem from '@deepseek-ai/dsh-fs-local'
  20. import UserInteractionService from '@deepseek-ai/dsh-user-interaction'
  21. import WebService from '@deepseek-ai/dsh-web'
  22. import * as WebSearchExa from '@deepseek-ai/dsh-web-search-exa'
  23. import * as WebFetchLocal from '@deepseek-ai/dsh-web-fetch-local'
  24. import SubagentService from '@deepseek-ai/dsh-subagent'
  25. import type { SubagentProvider } from '@deepseek-ai/dsh-subagent'
  26. import SkillService from '@deepseek-ai/dsh-skill'
  27. import * as SkillLocal from '@deepseek-ai/dsh-skill-local'
  28. import TaskService from '@deepseek-ai/dsh-tasks'
  29. import * as ToolAskUser from '@deepseek-ai/dsh-tool-ask-user'
  30. import * as ToolBash from '@deepseek-ai/dsh-tool-bash'
  31. import * as ToolCordis from '@deepseek-ai/dsh-tool-cordis'
  32. import * as ToolFs from '@deepseek-ai/dsh-tool-fs'
  33. import * as ToolFsSearch from '@deepseek-ai/dsh-tool-fs-search'
  34. import * as ToolGoal from '@deepseek-ai/dsh-tool-goal'
  35. import * as ToolSkill from '@deepseek-ai/dsh-tool-skill'
  36. import * as ToolTasks from '@deepseek-ai/dsh-tool-tasks'
  37. import * as ToolTodo from '@deepseek-ai/dsh-tool-todo'
  38. import * as ToolSubagent from '@deepseek-ai/dsh-tool-subagent'
  39. import * as ToolWeb from '@deepseek-ai/dsh-tool-web'
  40. import VmWorkflowEngine from '@deepseek-ai/dsh-workflow-workerthread'
  41. import * as ToolRalph from '@deepseek-ai/dsh-tool-ralph'
  42. import * as ToolWorkflow from '@deepseek-ai/dsh-tool-workflow'
  43. const root = resolve(import.meta.dirname, '..')
  44. const OUT = 'docs/tool-catalog.md'
  45. const CATALOG_RG_PROBE_COMMAND = 'command -v rg >/dev/null 2>&1'
  46. /**
  47. * Minimal bash service for harvesting `dsh-tool-fs-search` schemas. The search
  48. * plugin now probes `rg` at registration time, but the generated catalog must
  49. * remain independent of the host PATH and never execute a real search.
  50. */
  51. class CatalogSearchBashExecutor extends BashExecutor {
  52. override resolve(request: BashExecRequest): BashExecSpec {
  53. return {
  54. command: request.command,
  55. workdir: request.workdir ?? root,
  56. timeoutMs: request.timeoutMs ?? 60_000,
  57. stdoutMaxBytes: request.stdoutMaxBytes ?? 64_000,
  58. signal: request.signal,
  59. sandboxMode: request.sandboxMode,
  60. }
  61. }
  62. override run(spec: BashExecSpec): Promise<BashRunResult> {
  63. if (spec.command !== CATALOG_RG_PROBE_COMMAND) {
  64. throw new Error(`gen-tool-catalog: unexpected search bash command during schema harvest: ${spec.command}`)
  65. }
  66. return Promise.resolve({
  67. exitCode: 0,
  68. signal: null,
  69. timedOut: false,
  70. aborted: false,
  71. timeoutMs: spec.timeoutMs,
  72. stdout: { text: '', truncated: false },
  73. stderr: { text: '', truncated: false },
  74. })
  75. }
  76. override start(): BashProcess {
  77. throw new Error('gen-tool-catalog: search schema harvest must not start background processes')
  78. }
  79. }
  80. /**
  81. * Register the descriptor needed to mount schema-producing consumers. Declares
  82. * the full capability set of the shipped in-process providers so consumers
  83. * mount under their shipped defaults (tool-subagent's default numeric maxDepth
  84. * requires `depthLimit`).
  85. */
  86. function registerCatalogSubagentProvider(ctx: Context, name: string): void {
  87. const provider: SubagentProvider = {
  88. name,
  89. capabilities: { outputSchema: true, depthLimit: true, toolFilter: true, persona: true },
  90. inheritsParentContext: false,
  91. start: () => Promise.reject(new Error('tool-catalog provider cannot start a child')),
  92. }
  93. ctx.subagents.registerProvider(provider)
  94. }
  95. /**
  96. * Tool package plus its hand-maintained boot recipe. The caller mounts the
  97. * prompt and registry; each recipe supplies only package-specific seams and
  98. * config, while `dir` participates in the completeness check.
  99. */
  100. interface ToolPackage {
  101. /** The npm package name, used as the catalog section heading. */
  102. pkg: string
  103. /** The `packages/<group>/<dir>` leaf name — matched by the completeness guard. */
  104. dir: string
  105. /** Repo-relative source path linked from the catalog entry. */
  106. source: string
  107. /** Services or owning runtime surfaces the package requires at execution time. */
  108. requires: string[]
  109. /** Session events or other visible state the tools write or affect. */
  110. writes: string[]
  111. /** Additional model-visible names shipped by example/app config. */
  112. shippedNames?: string[]
  113. /** Plug the injected seams + the tool plugin onto a context that already
  114. * carries `systemPrompt` + `tools`. */
  115. mount: (ctx: Context) => Promise<void>
  116. /**
  117. * Config for the caller's `ToolRegistry` mount. The registry itself ships a
  118. * model-facing tool (`run_code`, registered under a non-native `mode`), so
  119. * ITS catalog entry boots the registry in the mode that surfaces it;
  120. * every other entry uses the default (native) registry.
  121. */
  122. toolsConfig?: ToolsConfig
  123. /**
  124. * A deployment note rendered after the package's tools, for a fact that
  125. * booting the package alone cannot show. The registered tool NAME can be a
  126. * load-time config (`tool-subagent`'s `toolName`), so one package may surface
  127. * under several names across deployments — the boot yields the package
  128. * DEFAULT, and this note records the shipped alternatives the model sees.
  129. */
  130. note?: string
  131. }
  132. /**
  133. * The boot manifest: every shipped tool package (a `tool-*` leaf under
  134. * `packages/`). Ordered by package name (the render order); the completeness
  135. * guard proves it is exhaustive against the on-disk glob.
  136. */
  137. const TOOL_PACKAGES: ToolPackage[] = [
  138. {
  139. pkg: '@deepseek-ai/dsh-tool-ask-user',
  140. dir: 'tool-ask-user',
  141. source: 'packages/ui/tool-ask-user/src/index.ts',
  142. requires: ['ctx.tools', 'ctx.userInteraction'],
  143. writes: ['tool/call', 'tool/result after a UI/provider answers the question'],
  144. async mount(ctx) {
  145. await ctx.plugin(UserInteractionService)
  146. await ctx.plugin(ToolAskUser)
  147. },
  148. note:
  149. 'ask_user_question pauses the tool call until the active UI provider returns a human answer.',
  150. },
  151. {
  152. pkg: '@deepseek-ai/dsh-tools',
  153. dir: 'tools',
  154. source: 'packages/core/tools/src/code-mode.ts',
  155. requires: ['ctx.tools', 'ctx.codeRuntime (execution time)', 'ctx.systemPrompt'],
  156. writes: ['tool/call', 'one tool/code-dispatch per bridged sub-call', 'tool/result'],
  157. // The registry's OWN tool: run_code exists only under a non-native mode
  158. // (the registry registers it in its constructor; the code runtime is read
  159. // at assembly/execution time, so the schema harvest needs none mounted).
  160. toolsConfig: { mode: 'code' },
  161. async mount() {},
  162. note:
  163. 'Owned by the tool registry as a reserved transport outside filterable capability layers under `mode: code` / `mode: both` (see the Code Mode Agent Note). Under `code` it is the registry\'s only wire contribution; the other visible capabilities are declared in a generated TypeScript SDK section, and a program calls them through serialized bindings that re-enter the complete guarded tool pipeline and link each nested execution to this outer result.',
  164. },
  165. {
  166. pkg: '@deepseek-ai/dsh-tool-bash',
  167. dir: 'tool-bash',
  168. source: 'packages/bash/tool-bash/src/index.ts',
  169. requires: ['ctx.tools', 'ctx.bash', 'ctx.tasks at call time for run_in_background'],
  170. writes: ['tool/call', 'tool/result'],
  171. async mount(ctx) {
  172. await ctx.plugin(LocalBashExecutor)
  173. await ctx.plugin(ToolBash)
  174. },
  175. note:
  176. 'The bash tool is the model-facing consumer of the bash executor seam. A `run_in_background` run registers with the generic `ctx.tasks` runtime and is collected/stopped through the `task_*` tools from `@deepseek-ai/dsh-tool-tasks`; the `enableRunInBackground` config (default true) removes the parameter entirely when disabled.',
  177. },
  178. {
  179. pkg: '@deepseek-ai/dsh-tool-cordis',
  180. dir: 'tool-cordis',
  181. source: 'packages/cordis/tool-cordis/src/index.ts',
  182. requires: ['ctx.tools'],
  183. writes: ['tool/call', 'tool/result', 'live plugin-tree mutations (mount/unmount)'],
  184. async mount(ctx) {
  185. await ctx.plugin(ToolCordis)
  186. },
  187. note:
  188. 'Ships in examples/cordis-agent only (a deliberate opt-in — mounted code gets the real ctx, see .agents/notes/implemented/feature/2026-07-08-self-referential-cordis-toolset.md). Plugins the model mounts may register ADDITIONAL model-visible tools at runtime; a full changed request header logs those tool-set changes.',
  189. },
  190. {
  191. pkg: '@deepseek-ai/dsh-tool-fs',
  192. dir: 'tool-fs',
  193. source: 'packages/fs/tool-fs/src/index.ts',
  194. requires: ['ctx.tools', 'ctx.fs', 'ctx.systemPrompt'],
  195. writes: ['tool/call', 'fs/write-intent or fs/edit-intent for mutations', 'fs/observed after successful file operations', 'tool/result'],
  196. async mount(ctx) {
  197. // The tool needs `fs`; the bare provider is sufficient because policy
  198. // changes behavior, not schema shape.
  199. await ctx.plugin(LocalFileSystem)
  200. await ctx.plugin(ToolFs)
  201. },
  202. note:
  203. 'The read-before-write/edit policy is added by `@deepseek-ai/dsh-fs-policy` (an `fs/*` event-gate plugin, no schema change); a deployment that loads these tools is expected to also load it. The tool schemas above are identical with or without the policy plugin.',
  204. },
  205. {
  206. pkg: '@deepseek-ai/dsh-tool-fs-search',
  207. dir: 'tool-fs-search',
  208. source: 'packages/fs/tool-fs-search/src/index.ts',
  209. requires: ['ctx.tools', 'ctx.bash', 'ctx.systemPrompt'],
  210. writes: ['tool/call', 'tool/result'],
  211. async mount(ctx) {
  212. // The tools inject `bash` (search executes fixed `rg` commands through
  213. // the executor seam, not ctx.fs). Use a catalog-only executor so the
  214. // registration-time `rg` probe stays deterministic and the generator
  215. // never depends on the host PATH. `ctx.spillStore` is optional (read via
  216. // ctx.get) and does not affect the schemas, so no spill backend is mounted.
  217. await ctx.plugin(CatalogSearchBashExecutor)
  218. await ctx.plugin(ToolFsSearch)
  219. },
  220. note:
  221. 'glob and grep are conditional bash-backed discovery tools: they register only when ctx.bash can find `rg`, then run fixed ripgrep commands through ctx.bash as ordinary foreground calls (never background tasks). Capped results save the complete formatted list through the optional ctx.spillStore backend; returned locators are follow-up-readable/searchable when the backend exposes local paths in co-located deployments.',
  222. },
  223. {
  224. pkg: '@deepseek-ai/dsh-tool-goal',
  225. dir: 'tool-goal',
  226. source: 'packages/goal/tool-goal/src/index.ts',
  227. requires: ['ctx.tools', 'ctx.agents', 'ctx.goals', 'ctx.systemPrompt', 'a calling Agent in an authorized open turn'],
  228. writes: ['tool/call', 'context/message goal snapshot for mutations', 'tool/result'],
  229. async mount(ctx) {
  230. await ctx.plugin(AgentRegistry)
  231. await ctx.plugin(GoalService)
  232. await ctx.plugin(ToolGoal)
  233. },
  234. note:
  235. 'create, edit, pause, and resume require direct-human root authority; complete and blocked also accept the exact current goal round. The default blocked lower bound is three admitted rounds.',
  236. },
  237. {
  238. pkg: '@deepseek-ai/dsh-tool-ralph',
  239. dir: 'tool-ralph',
  240. source: 'packages/workflow/tool-ralph/src/index.ts',
  241. requires: ['ctx.tools', 'ctx.workflows', 'ctx.subagents', 'ctx.systemPrompt', 'a calling Agent (exec.agent parents every fresh round)'],
  242. writes: ['tool/call', 'tool/result', 'workflow and child session events during execution'],
  243. async mount(ctx) {
  244. await ctx.plugin(SubagentService)
  245. registerCatalogSubagentProvider(ctx, 'mock')
  246. await ctx.plugin(VmWorkflowEngine, { provider: 'mock' })
  247. await ctx.plugin(ToolRalph, { subagentProvider: 'mock' })
  248. },
  249. note:
  250. 'A fixed foreground workflow starts one fresh structured child per round; the model selects only the immutable objective and an optional round cap.',
  251. },
  252. {
  253. pkg: '@deepseek-ai/dsh-tool-skill',
  254. dir: 'tool-skill',
  255. source: 'packages/skill/tool-skill/src/index.ts',
  256. requires: ['ctx.tools', 'ctx.skills'],
  257. writes: ['tool/call', 'tool/result'],
  258. async mount(ctx) {
  259. await ctx.plugin(SkillService)
  260. await ctx.plugin(SkillLocal, {
  261. dshHome: resolve(root, '.tmp/tool-catalog/.dsh'),
  262. agentsHome: resolve(root, '.tmp/tool-catalog/.agents'),
  263. })
  264. await ctx.plugin(ToolSkill)
  265. },
  266. },
  267. {
  268. pkg: '@deepseek-ai/dsh-tool-subagent',
  269. dir: 'tool-subagent',
  270. source: 'packages/subagent/tool-subagent/src/index.ts',
  271. requires: ['ctx.tools', 'ctx.subagents'],
  272. writes: ['tool/call', 'tool/result', 'child session events through the chosen provider'],
  273. shippedNames: ['subagent', 'subagent_fork'],
  274. async mount(ctx) {
  275. await ctx.plugin(SubagentService)
  276. registerCatalogSubagentProvider(ctx, 'mock')
  277. await ctx.plugin(ToolSubagent, { provider: 'mock' })
  278. },
  279. note:
  280. 'The registered tool name is the load-time `toolName` config (default `subagent`); the schema above is that default. The shipped example agents load this package once per subagent backend, so the model additionally sees `subagent_fork` (bound to the fork backend) with an identical schema — see `examples/tui-agent/cordis.yml` and `examples/acp-agent/cordis.yml`.',
  281. },
  282. {
  283. pkg: '@deepseek-ai/dsh-tool-tasks',
  284. dir: 'tool-tasks',
  285. source: 'packages/tasks/tool-tasks/src/index.ts',
  286. requires: ['ctx.tools', 'ctx.tasks', 'ctx.systemPrompt'],
  287. writes: ['tool/call', 'tool/result', 'context/message via agent.inject() for background completion notices'],
  288. async mount(ctx) {
  289. await ctx.plugin(TaskService)
  290. await ctx.plugin(ToolTasks)
  291. },
  292. note:
  293. 'The kind-agnostic background-task control surface: a background bash command and a background subagent are read, listed, and killed through the same three tools. Loading the plugin attaches the control surface that arms producers\' `ctx.tasks.start()`.',
  294. },
  295. {
  296. pkg: '@deepseek-ai/dsh-tool-todo',
  297. dir: 'tool-todo',
  298. source: 'packages/todo/tool-todo/src/index.ts',
  299. requires: ['ctx.tools', 'owning Agent session'],
  300. writes: ['tool/call', 'todo/write', 'tool/result'],
  301. async mount(ctx) {
  302. await ctx.plugin(ToolTodo)
  303. },
  304. note:
  305. 'todo_write is session-owned state; UIs render the latest todo/write event as a checklist or ACP plan.',
  306. },
  307. {
  308. pkg: '@deepseek-ai/dsh-tool-workflow',
  309. dir: 'tool-workflow',
  310. source: 'packages/workflow/tool-workflow/src/index.ts',
  311. requires: ['ctx.tools', 'ctx.workflows', 'ctx.systemPrompt', 'a calling Agent (exec.agent parents the script children)'],
  312. writes: ['tool/call', 'tool/result'],
  313. async mount(ctx) {
  314. // The tool injects `workflows`; boot the vm engine over a scripted
  315. // subagent provider to satisfy it. The schema does not depend on which
  316. // provider backs the engine.
  317. await ctx.plugin(SubagentService)
  318. registerCatalogSubagentProvider(ctx, 'mock')
  319. await ctx.plugin(VmWorkflowEngine, { provider: 'mock' })
  320. await ctx.plugin(ToolWorkflow)
  321. },
  322. },
  323. {
  324. pkg: '@deepseek-ai/dsh-tool-web',
  325. dir: 'tool-web',
  326. source: 'packages/web/tool-web/src/index.ts',
  327. requires: ['ctx.tools', 'ctx.web', 'ctx.systemPrompt'],
  328. writes: ['tool/call', 'tool/result'],
  329. async mount(ctx) {
  330. // Mount search and fetch providers so both tools register. Their schemas
  331. // do not depend on provider identity or availability.
  332. await ctx.plugin(WebService)
  333. await ctx.plugin(WebSearchExa)
  334. await ctx.plugin(WebFetchLocal)
  335. await ctx.plugin(ToolWeb)
  336. },
  337. note:
  338. 'web_search and web_fetch keep provider selection behind ctx.web so model-visible schemas stay stable across backend swaps.',
  339. },
  340. ]
  341. /** One package's contribution to the catalog: its schemas plus attribution. */
  342. interface CatalogPackage {
  343. pkg: string
  344. source: string
  345. requires: string[]
  346. writes: string[]
  347. shippedNames?: string[]
  348. schemas: ToolSchema[]
  349. /** A deployment note (see {@link ToolPackage.note}), rendered after the tools. */
  350. note?: string
  351. }
  352. /** The whole catalog: one entry per booted tool package, in manifest order. */
  353. export type ToolCatalog = CatalogPackage[]
  354. /**
  355. * Assert the boot manifest covers every shipped tool package on disk (a
  356. * `tool-*` leaf under `packages/`).
  357. * Booting has no source declaration to enumerate, so this glob restores the
  358. * "a new tool cannot be silently undocumented" guarantee: an unlisted package
  359. * fails the generator (and the freshness gate) until it is added to
  360. * {@link TOOL_PACKAGES}. Exported for a direct negative test.
  361. *
  362. * `scanRoot` defaults to the repo root; a test may point it at a fixture tree.
  363. */
  364. export function assertManifestComplete(packages: ToolPackage[] = TOOL_PACKAGES, scanRoot: string = root): void {
  365. const onDisk = globSync('packages/*/tool-*', { cwd: scanRoot }).map(p => basename(p)).sort()
  366. const listed = new Set(packages.map(p => p.dir))
  367. const missing = onDisk.filter(dir => !listed.has(dir))
  368. if (missing.length > 0) {
  369. throw new Error(
  370. `gen-tool-catalog: ${missing.length} tool package(s) not in the boot manifest: ${missing.join(', ')}. `
  371. + 'Add each to TOOL_PACKAGES in scripts/gen-tool-catalog.ts so its schema is catalogued.',
  372. )
  373. }
  374. }
  375. /**
  376. * Boot each tool package on a fresh Context and harvest its model-facing
  377. * schemas. A fresh Context per package keeps attribution clean (each entry's
  378. * schemas come from exactly that package) and isolates a boot failure to its
  379. * own entry. Disposed after harvest so no executor/provider outlives the run.
  380. */
  381. export async function collectToolCatalog(packages: ToolPackage[] = TOOL_PACKAGES): Promise<ToolCatalog> {
  382. assertManifestComplete(packages)
  383. const catalog: ToolCatalog = []
  384. for (const entry of packages) {
  385. const ctx = new Context()
  386. // Dispose in `finally` so a throw from `mount`/`schemas()` after earlier
  387. // plugins mounted still tears the context down (no leaked executor/provider
  388. // fiber) — the repo's "dispose must reach quiescence" rule.
  389. try {
  390. await ctx.plugin(SystemPrompt)
  391. await ctx.plugin(ToolRegistry, entry.toolsConfig ?? {})
  392. await entry.mount(ctx)
  393. const schemas = ctx.tools.schemas().sort((a, b) => a.name.localeCompare(b.name))
  394. catalog.push({
  395. pkg: entry.pkg,
  396. source: entry.source,
  397. requires: entry.requires,
  398. writes: entry.writes,
  399. schemas,
  400. ...entry.shippedNames !== undefined ? { shippedNames: entry.shippedNames } : {},
  401. ...entry.note !== undefined ? { note: entry.note } : {},
  402. })
  403. } finally {
  404. await ctx.fiber.dispose()
  405. }
  406. }
  407. return catalog
  408. }
  409. /** Render one tool's entry: name, description, JSON-Schema parameters, source. */
  410. function renderTool(schema: ToolSchema, source: string): string[] {
  411. const out = [`### \`${schema.name}\``, '']
  412. if (schema.description) out.push(schema.description, '')
  413. out.push('```json', JSON.stringify(schema.parameters, null, 2), '```', '')
  414. out.push(`Source: [\`${source}\`](../${source})`, '')
  415. return out
  416. }
  417. function codeList(values: string[] | undefined): string {
  418. return values?.length ? values.map(value => `\`${value}\``).join(', ') : '-'
  419. }
  420. function tableCell(value: string | undefined): string {
  421. return value ? value.replace(/\|/g, '\\|').replace(/\n/g, '<br>') : '-'
  422. }
  423. /** Render the full catalog (pure, deterministic given the manifest-ordered input). */
  424. export function render(catalog: ToolCatalog): string {
  425. const lines: string[] = [
  426. '<!-- Generated by scripts/gen-tool-catalog.ts — do not edit by hand.',
  427. ' Run `pnpm run gen-tool-catalog` to regenerate. -->',
  428. '',
  429. '# Tool Schema Catalog',
  430. '',
  431. 'Every model-facing tool a shipped plugin contributes to `ctx.tools`: the `name`, `description`, and JSON-Schema `parameters` the model receives via the system-prompt assembly. It complements the cordis [events](cordis-catalog/events.md) & [services](cordis-catalog/services.md) catalogs (the wiring a plugin listens to and calls) and [core-data-structures/](core-data-structures/core.md) (the types those signatures move) — this page is the *tools* the agent is offered.',
  432. '',
  433. 'This file is GENERATED and verified fresh by `pnpm run verify-tool-catalog` (part of `doc-sync`) — do not edit it by hand. Unlike the cordis catalog (a pure source-AST pass), this generator BOOTS each tool plugin on a real context and reads `ctx.tools.schemas()`, because a tool schema is not statically knowable (runtime-spread enums, concatenated descriptions, config-driven names, raw-JSON-Schema MCP tools). A completeness guard globs `packages/*/tool-*` and fails if any package is missing from the generator\'s boot manifest, so a new tool cannot be silently undocumented. See [the tool-schema-catalog Agent Note](../.agents/notes/implemented/process/2026-07-02-tool-schema-catalog.md).',
  434. '',
  435. 'Scope: shipped product tools under `packages/*/tool-*`, each booted with its DEFAULT config. The registered tool NAME can be a load-time config (e.g. `tool-subagent`\'s `toolName`), so a deployment may surface a package under a different or additional name — a per-package note records those shipped aliases where they exist. The `examples/` demo tools (e.g. `echo`) are excluded, matching the cordis catalog\'s packages-only scope.',
  436. '',
  437. '## Tool Package Map',
  438. '',
  439. 'This table connects model-visible tool names to the plugin package and service seams behind them. Exact JSON Schemas follow in the package sections below.',
  440. '',
  441. '| Tool package | Model-visible names | Requires | Writes / affects | Shipped aliases | Deployment note |',
  442. '| --- | --- | --- | --- | --- | --- |',
  443. ...catalog.map(entry => `| \`${entry.pkg}\` | ${codeList(entry.schemas.map(schema => schema.name))} | ${codeList(entry.requires)} | ${codeList(entry.writes)} | ${codeList(entry.shippedNames)} | ${tableCell(entry.note)} |`),
  444. '',
  445. ]
  446. for (const entry of catalog) {
  447. lines.push(`## \`${entry.pkg}\``, '')
  448. for (const schema of entry.schemas) lines.push(...renderTool(schema, entry.source))
  449. if (entry.note) lines.push(entry.note, '')
  450. }
  451. return lines.join('\n')
  452. }
  453. /** CLI entry: default writes the catalog, `--check` fails if the committed copy
  454. * is stale. Guarded behind an entry-point check so importing this module for
  455. * tests neither regenerates the committed file nor calls process.exit. */
  456. async function main(): Promise<void> {
  457. const content = render(await collectToolCatalog())
  458. if (process.argv.includes('--check')) {
  459. let committed: string | null = null
  460. try {
  461. committed = readFileSync(resolve(root, OUT), 'utf8')
  462. } catch {
  463. // Only ENOENT (not yet generated) is expected; a present-but-unreadable
  464. // file is not a state this repo produces. Either way the remedy is the
  465. // same — regenerate — so treat a read failure as "stale".
  466. committed = null
  467. }
  468. if (committed === content) {
  469. console.log(`gen-tool-catalog: ${OUT} is up to date.`)
  470. process.exit(0)
  471. }
  472. console.error(`gen-tool-catalog: ${OUT} is stale. Run \`pnpm run gen-tool-catalog\` and commit ${OUT}.`)
  473. process.exit(1)
  474. }
  475. writeFileSync(resolve(root, OUT), content)
  476. console.log(`gen-tool-catalog: wrote ${OUT}.`)
  477. }
  478. // Run only when invoked as a script, not when imported by a test.
  479. if (process.argv[1] && import.meta.filename === resolve(process.argv[1])) {
  480. await main()
  481. }