tool-schemas.expected.json 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518
  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": "list_agents",
  120. "description": "List your continuable background subagents by durable id and label. Status is a snapshot of the stored record: running means the subagent session is currently live in this process, complete means it exists only in storage and a `send_message` starts a new turn on the same conversation. The snapshot is not a delivery promise — `send_message` performs the authoritative check and may still fail. Children that could not be read are reported as diagnostics instead of being silently dropped.",
  121. "parameters": {
  122. "type": "object",
  123. "properties": {}
  124. }
  125. },
  126. {
  127. "name": "ralph",
  128. "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.",
  129. "parameters": {
  130. "type": "object",
  131. "properties": {
  132. "objective": {
  133. "type": "string",
  134. "description": "The immutable completion objective for every fresh Ralph round."
  135. },
  136. "maxRounds": {
  137. "type": "number",
  138. "description": "Optional positive safe-integer round cap, bounded by the deployment ceiling."
  139. }
  140. },
  141. "required": [
  142. "objective"
  143. ]
  144. }
  145. },
  146. {
  147. "name": "read",
  148. "description": "Read a UTF-8 text file and return line-numbered content.",
  149. "parameters": {
  150. "type": "object",
  151. "properties": {
  152. "file_path": {
  153. "type": "string",
  154. "description": "Path to read, resolved by the filesystem backend."
  155. },
  156. "offset": {
  157. "type": "number",
  158. "description": "1-based first line to return. Defaults to 1."
  159. },
  160. "limit": {
  161. "type": "number",
  162. "description": "Maximum number of lines to return. Defaults to 2000."
  163. }
  164. },
  165. "required": [
  166. "file_path"
  167. ]
  168. }
  169. },
  170. {
  171. "name": "send_message",
  172. "description": "Send a message to a background subagent by its subagent id, continuing the same conversation. It becomes the subagent's next turn: if it is still working, the message waits until its current turn finishes, so it cannot redirect work already underway. This call returns no answer from the subagent — only confirmation that the message was delivered — so use it to give it more work. A failure means the message was NOT delivered.",
  173. "parameters": {
  174. "type": "object",
  175. "properties": {
  176. "subagent_id": {
  177. "type": "string",
  178. "description": "The subagent id returned when the background subagent was started."
  179. },
  180. "message": {
  181. "type": "string",
  182. "description": "The message to deliver to the subagent."
  183. }
  184. },
  185. "required": [
  186. "subagent_id",
  187. "message"
  188. ]
  189. }
  190. },
  191. {
  192. "name": "skill",
  193. "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.",
  194. "parameters": {
  195. "type": "object",
  196. "properties": {
  197. "name": {
  198. "type": "string",
  199. "description": "The exact skill name from the available skills list."
  200. }
  201. },
  202. "required": [
  203. "name"
  204. ]
  205. }
  206. },
  207. {
  208. "name": "subagent",
  209. "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 start a background subagent that keeps its conversation: you receive only its subagent id, never its result, and it works on its own. Use this for work whose result you do not need returned by this call; `send_message` sends it more work.",
  210. "parameters": {
  211. "type": "object",
  212. "properties": {
  213. "description": {
  214. "type": "string",
  215. "description": "A short (3-5 word) description of the delegated task, for display."
  216. },
  217. "prompt": {
  218. "type": "string",
  219. "description": "The complete, self-contained task for the subagent. It does not share this conversation's context, so include everything it needs."
  220. },
  221. "run_in_background": {
  222. "type": "boolean",
  223. "description": "Run as a background subagent that keeps its conversation and return only its subagent id. This call never returns its result; send it more work with send_message."
  224. }
  225. },
  226. "required": [
  227. "description",
  228. "prompt"
  229. ]
  230. }
  231. },
  232. {
  233. "name": "subagent_fork",
  234. "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 start a background subagent that keeps its conversation: you receive only its subagent id, never its result, and it works on its own. Use this for work whose result you do not need returned by this call; `send_message` sends it more work.",
  235. "parameters": {
  236. "type": "object",
  237. "properties": {
  238. "description": {
  239. "type": "string",
  240. "description": "A short (3-5 word) description of the delegated task, for display."
  241. },
  242. "prompt": {
  243. "type": "string",
  244. "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."
  245. },
  246. "run_in_background": {
  247. "type": "boolean",
  248. "description": "Run as a background subagent that keeps its conversation and return only its subagent id. This call never returns its result; send it more work with send_message."
  249. }
  250. },
  251. "required": [
  252. "description",
  253. "prompt"
  254. ]
  255. }
  256. },
  257. {
  258. "name": "task_kill",
  259. "description": "Request cancellation of a running background task by task id. Returns immediately; the task settles as killed once its work actually stops.",
  260. "parameters": {
  261. "type": "object",
  262. "properties": {
  263. "task_id": {
  264. "type": "string",
  265. "description": "Task id returned by the tool that started the background work."
  266. },
  267. "reason": {
  268. "type": "string",
  269. "description": "Optional short reason, recorded in the log and forwarded to the task."
  270. }
  271. },
  272. "required": [
  273. "task_id"
  274. ]
  275. }
  276. },
  277. {
  278. "name": "task_list",
  279. "description": "List your background tasks (running and finished) with their ids, kinds, and statuses.",
  280. "parameters": {
  281. "type": "object",
  282. "properties": {}
  283. }
  284. },
  285. {
  286. "name": "task_output",
  287. "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.",
  288. "parameters": {
  289. "type": "object",
  290. "properties": {
  291. "task_id": {
  292. "type": "string",
  293. "description": "Task id returned by the tool that started the background work."
  294. },
  295. "wait": {
  296. "type": "boolean",
  297. "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."
  298. },
  299. "timeout_ms": {
  300. "type": "number",
  301. "description": "Max wait in milliseconds (only meaningful with wait: true). Defaults to the configured wait timeout; capped by the configured maximum."
  302. }
  303. },
  304. "required": [
  305. "task_id"
  306. ]
  307. }
  308. },
  309. {
  310. "name": "todo_write",
  311. "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).",
  312. "parameters": {
  313. "type": "object",
  314. "properties": {
  315. "todos": {
  316. "type": "array",
  317. "description": "The COMPLETE task list, replacing any previous list.",
  318. "items": {
  319. "type": "object",
  320. "additionalProperties": false,
  321. "properties": {
  322. "content": {
  323. "type": "string",
  324. "description": "What the task is — a short imperative line."
  325. },
  326. "status": {
  327. "type": "string",
  328. "description": "pending (not started) | in_progress (now) | completed (done).",
  329. "enum": [
  330. "pending",
  331. "in_progress",
  332. "completed"
  333. ]
  334. }
  335. },
  336. "required": [
  337. "content",
  338. "status"
  339. ]
  340. }
  341. }
  342. },
  343. "required": [
  344. "todos"
  345. ]
  346. }
  347. },
  348. {
  349. "name": "update_goal",
  350. "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.",
  351. "parameters": {
  352. "type": "object",
  353. "properties": {
  354. "goal_id": {
  355. "type": "string",
  356. "description": "Exact id returned by get_goal."
  357. },
  358. "revision": {
  359. "type": "number",
  360. "description": "Exact positive revision returned by get_goal."
  361. },
  362. "action": {
  363. "type": "string",
  364. "description": "edit | pause | resume | complete | blocked",
  365. "enum": [
  366. "edit",
  367. "pause",
  368. "resume",
  369. "complete",
  370. "blocked"
  371. ]
  372. },
  373. "objective": {
  374. "type": "string",
  375. "description": "Replacement objective; valid only with action edit."
  376. },
  377. "max_goal_rounds": {
  378. "type": "number",
  379. "description": "Replacement cap; valid only with action edit."
  380. },
  381. "blocked_reason": {
  382. "type": "string",
  383. "description": "Concrete blocking condition; required only with action blocked."
  384. }
  385. },
  386. "required": [
  387. "goal_id",
  388. "revision",
  389. "action"
  390. ]
  391. }
  392. },
  393. {
  394. "name": "web_fetch",
  395. "description": "Fetch the content of a specific HTTP(S) URL and return it decoded to text.",
  396. "parameters": {
  397. "type": "object",
  398. "properties": {
  399. "url": {
  400. "type": "string",
  401. "description": "The HTTP(S) URL to fetch."
  402. }
  403. },
  404. "required": [
  405. "url"
  406. ]
  407. }
  408. },
  409. {
  410. "name": "workflow",
  411. "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.",
  412. "parameters": {
  413. "type": "object",
  414. "properties": {
  415. "script": {
  416. "type": "string",
  417. "description": "The plain-JS workflow script body (top-level await allowed; NO `export const meta` statement; end with `return <json-value>`)."
  418. },
  419. "meta": {
  420. "type": "object",
  421. "description": "The workflow identity block (plain JSON — never code).",
  422. "additionalProperties": true,
  423. "properties": {
  424. "name": {
  425. "type": "string",
  426. "description": "Short kebab-case workflow name."
  427. },
  428. "description": {
  429. "type": "string",
  430. "description": "One-line description of what the workflow does."
  431. },
  432. "whenToUse": {
  433. "type": "string",
  434. "description": "Optional guidance on when this workflow applies."
  435. },
  436. "phases": {
  437. "type": "array",
  438. "description": "Optional phase declarations matched by phase() calls.",
  439. "items": {
  440. "type": "object",
  441. "additionalProperties": true,
  442. "properties": {
  443. "title": {
  444. "type": "string",
  445. "description": "The phase title phase() calls match by exact string."
  446. },
  447. "detail": {
  448. "type": "string",
  449. "description": "Optional one-line description of the phase."
  450. },
  451. "provider": {
  452. "type": "string",
  453. "description": "Optional provider override this phase is expected to use."
  454. },
  455. "model": {
  456. "type": "string",
  457. "description": "Optional model override this phase is expected to use."
  458. }
  459. },
  460. "required": [
  461. "title"
  462. ]
  463. }
  464. }
  465. },
  466. "required": [
  467. "name",
  468. "description"
  469. ]
  470. },
  471. "args": {
  472. "type": "object",
  473. "description": "Optional JSON input exposed to the script as the `args` global (wrap a bare list as a field, e.g. {\"files\": [...]}).",
  474. "additionalProperties": true
  475. }
  476. },
  477. "required": [
  478. "script",
  479. "meta"
  480. ]
  481. }
  482. },
  483. {
  484. "name": "write",
  485. "description": "Create or fully replace a UTF-8 text file.",
  486. "parameters": {
  487. "type": "object",
  488. "properties": {
  489. "file_path": {
  490. "type": "string",
  491. "description": "Path to write, resolved by the filesystem backend."
  492. },
  493. "content": {
  494. "type": "string",
  495. "description": "Full UTF-8 text content to write."
  496. },
  497. "sandbox_permissions": {
  498. "type": "string",
  499. "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.",
  500. "enum": [
  501. "workspace-write",
  502. "danger-full-access"
  503. ]
  504. },
  505. "justification": {
  506. "type": "string",
  507. "description": "Required with sandbox_permissions: one sentence for the user explaining why this exact file operation needs the wider access."
  508. }
  509. },
  510. "required": [
  511. "file_path",
  512. "content"
  513. ]
  514. }
  515. }
  516. ],
  517. "changes": []
  518. }