tool-schemas.expected.json 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. {
  2. "initial": [
  3. {
  4. "name": "bash",
  5. "description": "Execute a bash command (`bash -c`) and return its stdout/stderr. Each call runs in a fresh shell: no state (cwd, variables, functions) persists between calls — pass `workdir` instead of using `cd`. Non-zero exits are reported as `[exit code: N]`. Current harness environment facts are exposed through managed `$DSH_*` variables; inspect them when needed. Commands may run under a file sandbox; a blocked file operation is reported as `[sandbox: file access denied under <mode> mode]` — a policy denial, not a bug in the command; do not retry another way. Long output is truncated to its tail; the full output is saved to a file whose path is reported when available. Set `run_in_background: true` for long-running commands: the call returns a task id immediately; read its output with `task_output` and stop it with `task_kill`. Attempting a command the sandbox may deny is safe and expected: run it and read the marker rather than assuming the denial. When a command is denied and a wider mode would let it succeed, escalate immediately in the same turn — the one sanctioned exception to a denial: retry the exact same command once with `sandbox_permissions` (the narrowest wider mode that suffices) plus a one-sentence `justification`. Do not detour through chat to ask permission first — the approval prompt raised by that retry is how the user consents. If the session states approval prompts are disabled, there is no exception: a denial is final — do not set `sandbox_permissions`. Never escalate speculatively: ground the request in a real denial — normally the one this command just hit; escalating up front is fine only when this session already denied the same access. A rejected escalation is final for that command — stop and explain, never work around it — but it does not forbid attempting or escalating other commands later.",
  6. "parameters": {
  7. "type": "object",
  8. "properties": {
  9. "command": {
  10. "type": "string",
  11. "description": "The bash command to execute."
  12. },
  13. "description": {
  14. "type": "string",
  15. "description": "Clear, concise description of what this command does in active voice, 5-10 words (shown in the UI). Examples: \"ls\" → \"List files in current directory\"; \"git status\" → \"Show working tree status\"; \"npm install\" → \"Install package dependencies\"."
  16. },
  17. "timeoutMs": {
  18. "type": "number",
  19. "description": "Timeout in milliseconds. The executor applies its configured default and cap, and kills the command on expiry."
  20. },
  21. "workdir": {
  22. "type": "string",
  23. "description": "Working directory for this command. Defaults to the session workspace; a relative path is resolved against it."
  24. },
  25. "run_in_background": {
  26. "type": "boolean",
  27. "description": "Run in the background and return a task id immediately (collect with task_output, stop with task_kill). No timeout applies."
  28. },
  29. "sandbox_permissions": {
  30. "type": "string",
  31. "description": "The wider sandbox mode this command needs. Only valid as a one-shot retry of a command the sandbox just denied; requires justification and user approval.",
  32. "enum": [
  33. "workspace-write",
  34. "danger-full-access"
  35. ]
  36. },
  37. "justification": {
  38. "type": "string",
  39. "description": "Required with sandbox_permissions: one sentence for the user explaining why this exact command needs the wider access."
  40. }
  41. },
  42. "required": [
  43. "command",
  44. "description"
  45. ]
  46. }
  47. },
  48. {
  49. "name": "create_goal",
  50. "description": "Create one persisted same-session completion goal when the current direct human request is a long-running objective that should continue across autonomous goal rounds. You may infer that intent without requiring the user to say \"create a goal\". Do not use this for trivial single-turn work. Execution rejects non-human and subagent authority.",
  51. "parameters": {
  52. "type": "object",
  53. "properties": {
  54. "objective": {
  55. "type": "string",
  56. "description": "The concrete completion objective inferred from the direct human request."
  57. },
  58. "max_goal_rounds": {
  59. "type": "number",
  60. "description": "Optional positive safe-integer limit on automatic continuation rounds."
  61. }
  62. },
  63. "required": [
  64. "objective"
  65. ]
  66. }
  67. },
  68. {
  69. "name": "edit",
  70. "description": "Edit an existing UTF-8 text file by replacing literal text.",
  71. "parameters": {
  72. "type": "object",
  73. "properties": {
  74. "file_path": {
  75. "type": "string",
  76. "description": "Path to edit, resolved by the filesystem backend."
  77. },
  78. "old_string": {
  79. "type": "string",
  80. "description": "Literal text to replace. Must match exactly."
  81. },
  82. "new_string": {
  83. "type": "string",
  84. "description": "Literal replacement text. Use an empty string to delete the match."
  85. },
  86. "replace_all": {
  87. "type": "boolean",
  88. "description": "Replace all matches. Defaults to false; when false, old_string must appear exactly once."
  89. },
  90. "sandbox_permissions": {
  91. "type": "string",
  92. "description": "The wider sandbox mode this file operation needs. Only valid as a one-shot retry of an operation the sandbox just denied; requires justification and user approval.",
  93. "enum": [
  94. "workspace-write",
  95. "danger-full-access"
  96. ]
  97. },
  98. "justification": {
  99. "type": "string",
  100. "description": "Required with sandbox_permissions: one sentence for the user explaining why this exact file operation needs the wider access."
  101. }
  102. },
  103. "required": [
  104. "file_path",
  105. "old_string",
  106. "new_string"
  107. ]
  108. }
  109. },
  110. {
  111. "name": "get_goal",
  112. "description": "Read the current same-session goal, including its exact id/revision, objective, phase, completed continuation rounds, round limit, blocker reason when present, and whether another continuation is armed. Call this before updating a goal.",
  113. "parameters": {
  114. "type": "object",
  115. "properties": {}
  116. }
  117. },
  118. {
  119. "name": "ralph",
  120. "description": "Run a foreground fresh-agent Ralph loop toward one immutable objective. Use only when the direct human explicitly asks for Ralph or fresh-agent iteration. Each round opens a new child with no parent conversation or prior child session; the shared workspace is long-term memory, and only a bounded structured report crosses rounds. The call returns when a worker reports completion or a concrete blocker, or at the round limit. Ordinary long-running same-session work belongs to goal tools.",
  121. "parameters": {
  122. "type": "object",
  123. "properties": {
  124. "objective": {
  125. "type": "string",
  126. "description": "The immutable completion objective for every fresh Ralph round."
  127. },
  128. "maxRounds": {
  129. "type": "number",
  130. "description": "Optional positive safe-integer round cap, bounded by the deployment ceiling."
  131. }
  132. },
  133. "required": [
  134. "objective"
  135. ]
  136. }
  137. },
  138. {
  139. "name": "read",
  140. "description": "Read a UTF-8 text file and return line-numbered content.",
  141. "parameters": {
  142. "type": "object",
  143. "properties": {
  144. "file_path": {
  145. "type": "string",
  146. "description": "Path to read, resolved by the filesystem backend."
  147. },
  148. "offset": {
  149. "type": "number",
  150. "description": "1-based first line to return. Defaults to 1."
  151. },
  152. "limit": {
  153. "type": "number",
  154. "description": "Maximum number of lines to return. Defaults to 2000."
  155. }
  156. },
  157. "required": [
  158. "file_path"
  159. ]
  160. }
  161. },
  162. {
  163. "name": "skill",
  164. "description": "Load the full instructions for an available skill. Call this with the exact skill name from the session skill catalog before acting on a task that names or clearly matches that skill.",
  165. "parameters": {
  166. "type": "object",
  167. "properties": {
  168. "name": {
  169. "type": "string",
  170. "description": "The exact skill name from the available skills list."
  171. }
  172. },
  173. "required": [
  174. "name"
  175. ]
  176. }
  177. },
  178. {
  179. "name": "subagent",
  180. "description": "Delegate a self-contained task to a subagent (a separate agent that works in its own context) and return its final result. Use this to offload focused, independent work — research, a scoped implementation, an analysis — so it does not consume this conversation's context. The subagent runs to completion and you receive only its final answer, not its intermediate steps. Give it a complete, standalone prompt: it does not see this conversation. Set `run_in_background: true` to return a task id; collect with `task_output` and stop with `task_kill`.",
  181. "parameters": {
  182. "type": "object",
  183. "properties": {
  184. "description": {
  185. "type": "string",
  186. "description": "A short (3-5 word) description of the delegated task, for display."
  187. },
  188. "prompt": {
  189. "type": "string",
  190. "description": "The complete, self-contained task for the subagent. It does not share this conversation's context, so include everything it needs."
  191. },
  192. "run_in_background": {
  193. "type": "boolean",
  194. "description": "Run as a background task and return its id; collect with task_output or stop with task_kill."
  195. }
  196. },
  197. "required": [
  198. "description",
  199. "prompt"
  200. ]
  201. }
  202. },
  203. {
  204. "name": "subagent_fork",
  205. "description": "Delegate a task to a subagent that inherits this conversation: a child agent seeded with all completed turns so far (it does not see the current in-flight turn), returning only its final result. Use this when the subtask builds on this conversation's context — a follow-up analysis, a review, a continuation — without consuming this conversation's context for the work itself. You receive only its final answer, not its intermediate steps. Set `run_in_background: true` to return a task id; collect with `task_output` and stop with `task_kill`.",
  206. "parameters": {
  207. "type": "object",
  208. "properties": {
  209. "description": {
  210. "type": "string",
  211. "description": "A short (3-5 word) description of the delegated task, for display."
  212. },
  213. "prompt": {
  214. "type": "string",
  215. "description": "The task for the subagent. It already sees this conversation's completed turns, so build on them freely and state only what is new."
  216. },
  217. "run_in_background": {
  218. "type": "boolean",
  219. "description": "Run as a background task and return its id; collect with task_output or stop with task_kill."
  220. }
  221. },
  222. "required": [
  223. "description",
  224. "prompt"
  225. ]
  226. }
  227. },
  228. {
  229. "name": "task_kill",
  230. "description": "Request cancellation of a running background task by task id. Returns immediately; the task settles as killed once its work actually stops.",
  231. "parameters": {
  232. "type": "object",
  233. "properties": {
  234. "task_id": {
  235. "type": "string",
  236. "description": "Task id returned by the tool that started the background work."
  237. },
  238. "reason": {
  239. "type": "string",
  240. "description": "Optional short reason, recorded in the log and forwarded to the task."
  241. }
  242. },
  243. "required": [
  244. "task_id"
  245. ]
  246. }
  247. },
  248. {
  249. "name": "task_list",
  250. "description": "List your background tasks (running and finished) with their ids, kinds, and statuses.",
  251. "parameters": {
  252. "type": "object",
  253. "properties": {}
  254. }
  255. },
  256. {
  257. "name": "task_output",
  258. "description": "Read a background task. Stream tasks return only output since the previous read; final-output tasks return their result after settlement. Every response ends with `[status: ...]`. Reads are non-blocking unless `wait: true`, which waits up to the configured cap.",
  259. "parameters": {
  260. "type": "object",
  261. "properties": {
  262. "task_id": {
  263. "type": "string",
  264. "description": "Task id returned by the tool that started the background work."
  265. },
  266. "wait": {
  267. "type": "boolean",
  268. "description": "Block until the task reaches a terminal status or the timeout expires. A timed-out wait returns [status: running] and leaves the task alive."
  269. },
  270. "timeout_ms": {
  271. "type": "number",
  272. "description": "Max wait in milliseconds (only meaningful with wait: true). Defaults to the configured wait timeout; capped by the configured maximum."
  273. }
  274. },
  275. "required": [
  276. "task_id"
  277. ]
  278. }
  279. },
  280. {
  281. "name": "todo_write",
  282. "description": "Record and update a structured task list for the current work. Send the ENTIRE list every call — it REPLACES the previous list (there are no partial updates, no per-item edits). Use it to plan multi-step work and show progress: add one todo per concrete step before you start. Keep AT MOST ONE todo `in_progress` at a time; while work remains, exactly one active task should be `in_progress`. Mark a todo `completed` the moment it is done (do not batch completions), and allow no `in_progress` item only once all work is complete. Skip the list for trivial single-step tasks. Statuses: `pending` (not started), `in_progress` (being worked on now), `completed` (finished).",
  283. "parameters": {
  284. "type": "object",
  285. "properties": {
  286. "todos": {
  287. "type": "array",
  288. "description": "The COMPLETE task list, replacing any previous list.",
  289. "items": {
  290. "type": "object",
  291. "additionalProperties": false,
  292. "properties": {
  293. "content": {
  294. "type": "string",
  295. "description": "What the task is — a short imperative line."
  296. },
  297. "status": {
  298. "type": "string",
  299. "description": "pending (not started) | in_progress (now) | completed (done).",
  300. "enum": [
  301. "pending",
  302. "in_progress",
  303. "completed"
  304. ]
  305. }
  306. },
  307. "required": [
  308. "content",
  309. "status"
  310. ]
  311. }
  312. }
  313. },
  314. "required": [
  315. "todos"
  316. ]
  317. }
  318. },
  319. {
  320. "name": "update_goal",
  321. "description": "Update the exact current goal revision. edit, pause, and resume require a direct top-level human request. During an automatic continuation of the current goal, complete and blocked are also allowed. blocked is rejected before the configured minimum round count; the model remains responsible for judging that the same condition persisted across those rounds and must explain it in blocked_reason.",
  322. "parameters": {
  323. "type": "object",
  324. "properties": {
  325. "goal_id": {
  326. "type": "string",
  327. "description": "Exact id returned by get_goal."
  328. },
  329. "revision": {
  330. "type": "number",
  331. "description": "Exact positive revision returned by get_goal."
  332. },
  333. "action": {
  334. "type": "string",
  335. "description": "edit | pause | resume | complete | blocked",
  336. "enum": [
  337. "edit",
  338. "pause",
  339. "resume",
  340. "complete",
  341. "blocked"
  342. ]
  343. },
  344. "objective": {
  345. "type": "string",
  346. "description": "Replacement objective; valid only with action edit."
  347. },
  348. "max_goal_rounds": {
  349. "type": "number",
  350. "description": "Replacement cap; valid only with action edit."
  351. },
  352. "blocked_reason": {
  353. "type": "string",
  354. "description": "Concrete blocking condition; required only with action blocked."
  355. }
  356. },
  357. "required": [
  358. "goal_id",
  359. "revision",
  360. "action"
  361. ]
  362. }
  363. },
  364. {
  365. "name": "workflow",
  366. "description": "Run a JavaScript workflow script that orchestrates subagents at scale. Use this for work that fans out across many independent pieces — an audit over many files, a migration, multi-angle research, adversarial verification of findings — where you write the orchestration as a script instead of delegating turn by turn.\n\nThe workflow's identity rides the `meta` parameter as JSON: required `name` (short kebab-case) and `description` strings, optional `whenToUse` string and `phases` array (`{title, detail?, provider?, model?}`). The `script` parameter is the plain JavaScript body ONLY (NOT TypeScript, and NO `export const meta` statement — meta is a parameter, not code), running with top-level await; end with `return <value>` — the value must be JSON-serializable and is this tool's result.\n\nScript-body hooks:\n- `agent(prompt, opts?): Promise<any>` — run one subagent to completion. Without `opts.schema` it resolves to the child's final text; with `opts.schema` (an object-rooted JSON Schema using ONLY type/properties/required/additionalProperties/items/enum/const/oneOf — no pattern/format/numeric bounds) it resolves to the validated object. Resolves `null` when the child fails (filter with `.filter(Boolean)`). Other opts: `label` (display), `phase` (progress group), and independent `provider`/`model` LLM target overrides (either may be provided alone). Anything else (`effort`/`isolation`/`agentType`) is rejected loudly.\n- `pipeline(items, ...stages): Promise<any[]>` — run each item through the stages independently with NO barrier between stages (prefer this for multi-stage work). Each stage receives `(prev, item, index)`. An ordinary stage throw drops that ITEM to `null` and skips its remaining stages.\n- `parallel(thunks): Promise<any[]>` — run zero-argument functions concurrently and await ALL of them (a barrier; use only when a stage genuinely needs every prior result together). A throwing thunk resolves to `null`.\n- `phase(title)` — start a progress phase; `log(message)` — narrate progress; `args` — the tool call's `args` input, verbatim.\n\nMisused hooks (bad arguments, unknown options, unsupported schemas, tripped caps) throw errors that ALWAYS kill the script — they never dissolve into a per-item `null`.\n\nConstraints: concurrency and total-agent caps apply; no filesystem, network, timers, or Node.js APIs are provided — the agents do the work, the script only coordinates them. The run executes in the foreground: this call returns when the whole script finishes.",
  367. "parameters": {
  368. "type": "object",
  369. "properties": {
  370. "script": {
  371. "type": "string",
  372. "description": "The plain-JS workflow script body (top-level await allowed; NO `export const meta` statement; end with `return <json-value>`)."
  373. },
  374. "meta": {
  375. "type": "object",
  376. "description": "The workflow identity block (plain JSON — never code).",
  377. "additionalProperties": true,
  378. "properties": {
  379. "name": {
  380. "type": "string",
  381. "description": "Short kebab-case workflow name."
  382. },
  383. "description": {
  384. "type": "string",
  385. "description": "One-line description of what the workflow does."
  386. },
  387. "whenToUse": {
  388. "type": "string",
  389. "description": "Optional guidance on when this workflow applies."
  390. },
  391. "phases": {
  392. "type": "array",
  393. "description": "Optional phase declarations matched by phase() calls.",
  394. "items": {
  395. "type": "object",
  396. "additionalProperties": true,
  397. "properties": {
  398. "title": {
  399. "type": "string",
  400. "description": "The phase title phase() calls match by exact string."
  401. },
  402. "detail": {
  403. "type": "string",
  404. "description": "Optional one-line description of the phase."
  405. },
  406. "provider": {
  407. "type": "string",
  408. "description": "Optional provider override this phase is expected to use."
  409. },
  410. "model": {
  411. "type": "string",
  412. "description": "Optional model override this phase is expected to use."
  413. }
  414. },
  415. "required": [
  416. "title"
  417. ]
  418. }
  419. }
  420. },
  421. "required": [
  422. "name",
  423. "description"
  424. ]
  425. },
  426. "args": {
  427. "type": "object",
  428. "description": "Optional JSON input exposed to the script as the `args` global (wrap a bare list as a field, e.g. {\"files\": [...]}).",
  429. "additionalProperties": true
  430. }
  431. },
  432. "required": [
  433. "script",
  434. "meta"
  435. ]
  436. }
  437. },
  438. {
  439. "name": "write",
  440. "description": "Create or fully replace a UTF-8 text file.",
  441. "parameters": {
  442. "type": "object",
  443. "properties": {
  444. "file_path": {
  445. "type": "string",
  446. "description": "Path to write, resolved by the filesystem backend."
  447. },
  448. "content": {
  449. "type": "string",
  450. "description": "Full UTF-8 text content to write."
  451. },
  452. "sandbox_permissions": {
  453. "type": "string",
  454. "description": "The wider sandbox mode this file operation needs. Only valid as a one-shot retry of an operation the sandbox just denied; requires justification and user approval.",
  455. "enum": [
  456. "workspace-write",
  457. "danger-full-access"
  458. ]
  459. },
  460. "justification": {
  461. "type": "string",
  462. "description": "Required with sandbox_permissions: one sentence for the user explaining why this exact file operation needs the wider access."
  463. }
  464. },
  465. "required": [
  466. "file_path",
  467. "content"
  468. ]
  469. }
  470. }
  471. ],
  472. "changes": []
  473. }