2026-06-12 23:28:44 +08:00
/**
* The model-facing bash tools: `bash`, `bash_output`, `bash_kill`. Pure
* schema + text shaping — every process concern lives behind the `ctx.bash`
* executor seam (`@deepseek-ai/dsh-bash`), so sandbox/permission/remote
* executor implementations swap in without touching what the model sees.
*
* Background notifications: when a background task completes, a short notice
* is injected into the owning agent's session (`agent.inject()` — the
* documented context seam). Injection is durable context for the NEXT model
* request, not a wake-up: an idle agent stays idle until something sends a
* message, which is why the tool descriptions tell the model to poll with
* `bash_output`.
*
2026-06-20 08:14:27 +08:00
* Task ownership: a background task's OWNER is an opaque token — the owning
2026-07-14 07:26:46 +08:00
* agent's shared `id` — passed to the executor at spawn
2026-06-20 08:14:27 +08:00
* (`resolve({ …, owner })`) and stored ON THE TASK inside the executor
* (`@deepseek-ai/dsh-bash`'s `ownerOf(id)` seam), NOT in a plugin-local map.
* `bash_output`/`bash_kill` compare `ctx.bash.ownerOf(id)` to the caller's token
* and reject a task owned by a DIFFERENT session (`owner !== undefined && owner
* !== caller`); an unowned task (no token — started by a non-agent caller) is
* open to anyone. Task ids are global and predictable (`bash-1`, …); under
* multi-session ACP (RFC 011) this token check is the fence that stops one
* session's agent from reading or killing another session's background task.
2026-06-16 19:23:21 +08:00
*
2026-06-20 13:38:48 +08:00
* Storing the token on the task in the EXECUTOR (disposed with the `dsh-bash`
* fiber), rather than in this plugin, is what makes ownership survive a
* `tool-bash` HMR reload — a reload that reset a plugin-local map would orphan
* a task spawned before it. (The `onTaskDone` listener is still effect-scoped
* to this plugin's `apply`, so a
2026-06-20 08:14:27 +08:00
* completion landing during the reload gap still drops its one notice — the
* pre-existing reload-gap drop — but the ownership fence itself is HMR-proof.)
2026-06-16 19:23:21 +08:00
*
2026-07-09 16:05:44 +08:00
* Commands run with the executor's full authority unless a sandboxing
* executor (`@deepseek-ai/dsh-bash-sandbox`) confines them; per-call
* allow/deny/ask policy is the `tools/pre-execute` waterfall — see
2026-07-09 16:37:10 +08:00
* docs/architecture.md § Extension And Composition. Under a sandboxing
* executor this plugin also advertises the ESCALATION surface
* (`sandbox_permissions`/`justification` — the sandbox RFC § Escalation,
2026-07-09 16:44:32 +08:00
* docs/rfc/implemented/feature/2026-07-06-sandbox.md): a command the
2026-07-09 16:37:10 +08:00
* sandbox denied may be retried once under a strictly wider mode, resolved
* through `ctx.approval` BEFORE anything executes and failing closed on every
* unanswerable path. The fields exist only when the mounted executor reports
* a confining default (`ctx.bash.sandboxMode`) — a lever is never advertised
2026-07-09 16:41:03 +08:00
* that the composition cannot honor.
*
* Per-session mode switching (the sandbox RFC § Per-session mode switching): a session may carry a
* standing sandbox-mode override — the `bash/sandbox-mode` event fold from
* `@deepseek-ai/dsh-bash` — which this plugin makes real at EXECUTION: each
* call is stamped `escalation grant > session override > executor default`.
* The prompt deliberately does NOT state the mode and no switch is narrated:
* the model learns the boundary from the denial marker (which names the mode
* it ran under) exactly when it matters, instead of preemptively refusing
* work a standing declaration would discourage.
2026-06-12 23:28:44 +08:00
*
* @module @deepseek-ai/dsh-tool-bash
*/
import type { Context } from 'cordis'
2026-06-17 10:01:18 +08:00
import { isAbsolute , resolve as resolvePath } from 'node:path'
2026-06-12 23:28:44 +08:00
import { defineTool } from '@deepseek-ai/dsh-tools'
2026-07-09 16:37:10 +08:00
import type { GenericCallView , TerminalCallView , ToolExecution , ToolResult , ToolResultView } from '@deepseek-ai/dsh-tools'
2026-06-12 23:28:44 +08:00
import type { Agent } from '@deepseek-ai/dsh-agent'
2026-07-09 16:37:10 +08:00
import { assertNever } from '@deepseek-ai/dsh-llm'
2026-07-05 01:54:46 +08:00
import type { } from '@deepseek-ai/dsh-system-prompt'
2026-07-09 16:37:10 +08:00
// Side-effect type import: declaration-merges `ctx.approval`, consumed
// opportunistically by the escalation gate (`ctx.get('approval')` — the seam
// stays optional at runtime, same pattern as dsh-tools' ask routing).
2026-07-11 21:37:38 +08:00
import type { } from '@deepseek-ai/dsh-user-approval'
2026-07-09 16:37:10 +08:00
import type { SandboxMode } from '@deepseek-ai/dsh-sandbox'
2026-07-09 16:41:03 +08:00
import { BashTaskId , OwnerToken , effectiveSandboxMode } from '@deepseek-ai/dsh-bash'
2026-06-12 23:28:44 +08:00
import type { BashRunResult , BashTask , CollectedOutput } from '@deepseek-ai/dsh-bash'
export const name = 'tool-bash'
2026-07-05 01:54:46 +08:00
export const inject = [ 'tools' , 'bash' , 'systemPrompt' ]
2026-06-12 23:28:44 +08:00
/**
2026-06-13 23:00:42 +08:00
* Validate the constraints the SchemaSpec can't express. `defineTool` now
2026-06-18 02:18:24 +08:00
* validates parsed args against the SchemaSpec before `execute` runs (the
* arg-validation RFC), so type/required/enum checks are already done and `args`
* is the validated `InferArgs` shape here. What remains are value constraints
2026-07-09 16:37:10 +08:00
* the DSL has no vocabulary for: non-empty strings, a positive finite timeout,
* and the escalation pairing (`sandbox_permissions` and `justification` travel
* together — an approval prompt without a reason, or a reason driving nothing,
* is a malformed ask).
2026-06-12 23:28:44 +08:00
*/
2026-07-09 16:37:10 +08:00
function validateBashArgs ( args : BashToolArgs ) : void {
2026-06-13 23:00:42 +08:00
if ( args . command . trim ( ) . length === 0 ) {
2026-06-12 23:28:44 +08:00
throw new Error ( 'invalid command: expected a non-empty string' )
}
2026-06-13 23:00:42 +08:00
if ( args . description . trim ( ) . length === 0 ) {
2026-06-12 23:28:44 +08:00
throw new Error ( 'invalid description: expected a non-empty string' )
}
2026-06-13 23:00:42 +08:00
if ( args . timeoutMs !== undefined && ( ! Number . isFinite ( args . timeoutMs ) || args . timeoutMs <= 0 ) ) {
2026-06-12 23:28:44 +08:00
throw new Error ( ` invalid timeoutMs: expected a positive number, got ${ JSON . stringify ( args . timeoutMs ) } ` )
}
2026-07-09 16:37:10 +08:00
if ( args . sandbox_permissions !== undefined && args . justification === undefined ) {
throw new Error ( 'invalid escalation: sandbox_permissions requires a justification' )
}
if ( args . justification !== undefined && args . sandbox_permissions === undefined ) {
throw new Error ( 'invalid escalation: justification is only valid together with sandbox_permissions' )
}
if ( args . justification !== undefined && args . justification . trim ( ) . length === 0 ) {
throw new Error ( 'invalid justification: expected a non-empty sentence' )
}
2026-06-12 23:28:44 +08:00
}
2026-06-13 23:00:42 +08:00
/**
* Reject an empty `task_id`. Type and presence are guaranteed by the
2026-06-18 02:18:24 +08:00
* SchemaSpec validation (the arg-validation RFC); only the non-empty constraint, which the
2026-06-13 23:00:42 +08:00
* DSL can't express, is left to check here.
*/
2026-06-21 07:17:25 +08:00
function validateTaskId ( value : string ) : BashTaskId {
2026-06-13 23:00:42 +08:00
if ( value . length === 0 ) {
2026-06-12 23:28:44 +08:00
throw new Error ( ` invalid task_id: expected a string, got ${ JSON . stringify ( value ) } ` )
}
2026-06-21 07:17:25 +08:00
return BashTaskId ( value )
2026-06-12 23:28:44 +08:00
}
2026-07-09 16:37:10 +08:00
/**
* The bash tool's validated argument shape — the base parameters plus the two
* escalation fields, which are ADVERTISED only when the mounted executor
* reports a confining default mode (absent from the schema otherwise, so the
* SchemaSpec validator rejects them before `execute` ever sees one).
*/
interface BashToolArgs {
command : string
description : string
timeoutMs? : number
workdir? : string
run_in_background? : boolean
sandbox_permissions? : string
justification? : string
}
/**
* The strictly-wider table: what a call whose effective mode is the key may
* escalate TO. Checked at EXECUTION, never baked into the schema — the
* schema's enum is {@link ESCALATION_TARGETS}, because schemas are
* registry-global while the effective mode is per-call truth.
*/
const WIDER_MODES : Record < string , readonly SandboxMode [ ] > = {
'read-only' : [ 'workspace-write' , 'danger-full-access' ] ,
'workspace-write' : [ 'danger-full-access' ] ,
}
/**
* The closed escalation-target vocabulary — every mode a call could ever
* escalate TO (`read-only` is the floor; nothing escalates to it). Advertised
* whenever the mounted executor confines: cutting the enum down to the modes
* wider than the executor's DEFAULT would strand a session whose effective
* mode sits below it (a `danger-full-access` default would advertise nothing
* while a narrower-switched session stays confined with no lever).
*/
const ESCALATION_TARGETS : readonly SandboxMode [ ] = [ 'workspace-write' , 'danger-full-access' ]
/**
* The bash tool's static description. The base text is byte-stable regardless
* of composition (it is part of the pinned snapshot header); the escalation
* teaching rides only when the mounted executor actually honors the fields —
* it names the ONE sanctioned exception to the base text's "do not retry
* another way" rule. Its deference clause ("If the session states approval
* prompts are disabled…") points at the approval plugin's never-policy prompt
* sentence by meaning, not by parsed wording — a rendezvous kept working by
* that sentence continuing to open with the approvals-disabled claim.
*/
function bashDescription ( escalationModes : readonly SandboxMode [ ] ) : string {
const base = '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]`. '
+ '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 (a background task reports the same marker via bash_output once it has finished). '
+ '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; '
+ 'poll it with `bash_output` and stop it with `bash_kill`.'
if ( escalationModes . length === 0 ) return base
return base + ' 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.'
}
2026-06-12 23:28:44 +08:00
/** Append the truncation notice (with the full-output spill path) to a stream's text. */
function streamText ( output : CollectedOutput ) : string {
if ( ! output . truncated ) return output . text
return ` ${ output . text } \ n[output truncated; full output: ${ output . spillPath ? ? '(unavailable)' } ] `
}
/**
* Shape one finished run into the text the model sees: stdout, then a marked
* stderr section, then exit-status markers. Non-zero exits are REPORTED, not
* errored — the model decides how to react; only infrastructure failures
* (spawn errors, aborts) surface as isError results.
2026-07-06 22:09:30 +08:00
* @param result - the completed foreground run from the executor.
2026-07-09 16:37:10 +08:00
* @param escalationModes - the escalation targets this composition advertises;
* non-empty adds the same-turn escalation hint after a denial marker
* (default `[]`: no hint).
2026-07-06 22:09:30 +08:00
* @returns the model-facing text: output body (or `(no output)`), then any timeout/signal/exit markers, each on its own line.
2026-06-12 23:28:44 +08:00
*/
2026-07-09 16:37:10 +08:00
export function renderResult (
result : BashRunResult ,
escalationModes : readonly SandboxMode [ ] = [ ] ,
) : string {
2026-06-12 23:28:44 +08:00
const out = streamText ( result . stdout )
const err = streamText ( result . stderr )
let body = out
if ( err . length > 0 ) {
// Single newline between sections (stdout usually ends with one already).
if ( body . length > 0 && ! body . endsWith ( '\n' ) ) body += '\n'
body += ` [stderr] \ n ${ err } `
}
if ( body . length === 0 ) body = '(no output)'
const markers : string [ ] = [ ]
2026-07-09 16:05:44 +08:00
// The sandbox marker precedes the exit-status markers so `[exit code: N]`
// stays the LAST line (exitStatus() anchors its parse there). Denial is a
// reported fact like timeout: the model decides how to react.
if ( result . sandbox ? . denied ) {
markers . push ( ` [sandbox: file access denied under ${ result . sandbox . mode } mode] ` )
2026-07-09 16:37:10 +08:00
// The same-turn nudge lives at the decision point: only when this
// composition advertises the fields (a lever is never hinted that the
// schema does not offer), and inside the sandbox marker family so the
// exit-code marker stays the last line.
if ( escalationModes . length > 0 ) {
markers . push ( '[sandbox: escalation available — retry this exact command once with sandbox_permissions (the narrowest wider mode that suffices) + justification; the approval prompt asks the user]' )
}
2026-07-09 16:05:44 +08:00
}
2026-06-12 23:28:44 +08:00
// Timeout is reported independently of how the process actually ended: a
// command can trap SIGTERM and exit 0 after our timer fired (e.g.
// `trap "exit 0" TERM; sleep 60`), giving timedOut:true / exitCode:0 /
// signal:null — the model must still see that the command was cut short.
if ( result . timedOut ) markers . push ( ` [timed out after ${ result . timeoutMs } ms] ` )
if ( result . signal !== null ) {
markers . push ( ` [killed by signal: ${ result . signal } ] ` )
} else if ( result . exitCode !== 0 ) {
markers . push ( ` [exit code: ${ result . exitCode } ] ` )
}
if ( markers . length === 0 ) return body
if ( ! body . endsWith ( '\n' ) ) body += '\n'
return body + markers . join ( '\n' )
}
2026-06-18 09:01:36 +08:00
// ---------------------------------------------------------------------------
// UI presentation (tool-owned). These shape how a UI (e.g. the ACP bridge)
// renders a bash call's pending and completed states. They are display-only and
// pure — a UI may call them during live streaming AND a session-log replay.
// ---------------------------------------------------------------------------
/**
2026-06-18 18:54:32 +08:00
* Pending-state presentation for a `bash` call. The TITLE is the exact `command`
* — a `kind: 'execute'` card is rendered as a terminal whose header label IS the
* title, and an execute-kind card HIDES `rawInput` (Zed: `should_show_raw_input
* = !is_terminal_tool`), so the command must BE the title to be seen. This
* mirrors the reference ACP adapters (claude-agent-acp, codex-acp), which both
* use the bare command as an execute tool's title. The model-written
* `description` (a readable summary) rides as a `content` text block shown ABOVE
2026-06-18 19:35:15 +08:00
* the card. (Note: claude-agent-acp DROPS the description in terminal mode and
* shows only the card; surfacing it as a content block is a deliberate
* divergence here — we keep the human summary visible alongside the card.)
* `rawInput` still carries the bare command for non-execute UIs that DO render it.
2026-06-18 17:25:09 +08:00
*
2026-06-18 19:35:15 +08:00
* `terminal` marks the call so a capable UI renders a TERMINAL card — but ONLY a
* FOREGROUND run is a terminal: a `run_in_background` call returns a task id
* immediately (it never streams a terminal; its output is polled via
* `bash_output`), so it is NOT marked terminal and renders as an ordinary
* execute card. For a foreground run the `terminal.cwd` (header) is the model
* `workdir` when given — ABSOLUTE as-is, RELATIVE for the UI bridge to resolve
* against the session cwd; when omitted the bridge fills the session workspace
* cwd (this PURE presenter, args only, can't see it).
2026-06-18 09:01:36 +08:00
*/
2026-06-18 19:35:15 +08:00
type BashCallArgs = { command : string ; description : string ; workdir? : string ; run_in_background? : boolean }
2026-07-03 02:04:03 +08:00
function presentBashCall ( args : BashCallArgs ) : GenericCallView | TerminalCallView {
// A background start is not an interactive terminal — a generic execute card
// with the command as rawInput and the description as a content block.
if ( args . run_in_background === true ) {
return {
card : 'generic' ,
title : args.command ,
kind : 'execute' ,
rawInput : args.command ,
content : [ { type : 'text' , text : args.description } ] ,
}
}
// A foreground run IS a terminal: the command titles the card, the description
// renders above it, and the cwd (when the model gave a workdir) heads it.
return {
card : 'terminal' ,
2026-06-18 18:54:32 +08:00
title : args.command ,
2026-07-03 02:04:03 +08:00
description : args.description ,
. . . args . workdir !== undefined ? { cwd : args.workdir } : { } ,
2026-06-18 17:25:09 +08:00
}
2026-06-18 09:01:36 +08:00
}
/**
2026-06-18 17:25:09 +08:00
* Completed-state presentation for a `bash` call. Two parallel renderings of the
* same output: `terminal.output` for a UI that shows a terminal card (the run's
2026-06-18 18:54:32 +08:00
* stdout/stderr + status markers, exactly as the model sees them — the RAW text,
* newlines preserved, since a terminal renderer relies on exact bytes), and a
* fenced ```console `content` block as the fallback for a UI without terminal
* support (the fences are a UI-only affordance, so they live here, not in the
* model-facing result; the fenced body is trimmed of trailing blank lines for a
* tidy block). A capable UI also gets an exit-status pill from `terminal.exitCode`
2026-06-18 19:35:15 +08:00
* / `terminal.signal`, parsed from the status markers `renderResult` appended.
*
* Terminal output/exit is suppressed for results that are NOT a finished
* foreground run: a `run_in_background` start (`isBackground` — the text is a
* task-id ack, not a streamed run) and an `isError` result (a spawn failure or
* abort — there is no real process exit to pill, and the body is an error
* message, not `renderResult` output, so parsing it would be meaningless). Those
2026-07-03 02:04:03 +08:00
* return a `generic` result whose content is the fenced ```console block. A
* finished foreground run returns a `terminal` result carrying the RAW output
* and the parsed exit status; the BRIDGE derives the fenced fallback from
* `output` for a UI without terminal support, so the tool does not double-encode
* it. A non-text result (unexpected for bash) falls through to `undefined`.
2026-06-18 09:01:36 +08:00
*/
2026-07-03 02:04:03 +08:00
function presentBashResult ( args : unknown , result : ToolResult ) : ToolResultView | undefined {
2026-06-18 09:01:36 +08:00
const block = result . content . length === 1 ? result . content [ 0 ] : undefined
if ( block === undefined || block . type !== 'text' ) return undefined
2026-06-18 18:54:32 +08:00
const raw = block . text
2026-06-18 19:35:15 +08:00
const isBackground = typeof args === 'object' && args !== null && ( args as { run_in_background? : unknown } ) . run_in_background === true
2026-07-03 02:04:03 +08:00
// A background ack or an errored run is not a real terminal exit: render the
// fenced ```console fallback as generic content (no exit pill).
if ( isBackground || result . isError ) {
return { card : 'generic' , content : [ { type : 'text' , text : ` \` \` \` console \ n ${ raw . replace ( /\n+$/ , '' ) } \ n \` \` \` ` } ] }
}
// A finished foreground run: RAW output + parsed exit for the terminal card.
// The bridge derives the no-capability fenced fallback from `output`.
return { card : 'terminal' , output : raw , . . . parseExitStatus ( raw ) }
2026-06-18 09:01:36 +08:00
}
2026-06-18 18:54:32 +08:00
/**
* Recover the structured exit status from a rendered `renderResult` string — the
* inverse of the status markers it appends. A `[killed by signal: SIG]` marker
* yields `{signal}`; otherwise an `[exit code: N]` marker yields `{exitCode:N}`;
2026-06-18 19:35:15 +08:00
* absent both we report `{exitCode:0}` (a clean run appends no marker — and a
* trapped-timeout run that exits 0 also has none and is accurately exit 0).
*
* Why parse rendered text at all: `presentResult` is replay-safe and on a
* `session/load` the ONLY thing persisted is this content text — the structured
* `BashRunResult` is long gone — so unless the exit were added to the persisted
* event schema (deliberately NOT done; see the terminal-rendering RFC), parsing
* is the only channel. The match is anchored to a LEADING newline + end-of-string
* because `renderResult` always inserts a `\n` before the marker (line ~124) onto
* a non-empty body: a real marker is therefore always its own final line. That
* defeats the common spoof (program output that simply ENDS in `[exit code: 5]`
* with no trailing newline — a clean exit 0 — no longer reads as a failure).
*
* KNOWN RESIDUAL (inherent to the replay-only-sees-text design): a clean exit 0
2026-06-18 19:45:05 +08:00
* whose body's FINAL line is itself exactly the marker text — `[exit code: N]`
* or `[killed by signal: SIG]`, printed by the program with nothing after — is
* still indistinguishable from a real marker and would show a wrong pill. This is
* display-only (execution and the model-facing text are unaffected) and narrow;
* the complete fix is to persist a structured exit on the result event, which the
* RFC names as the escape hatch.
2026-06-18 18:54:32 +08:00
*/
function parseExitStatus ( text : string ) : { exitCode : number } | { signal : string } {
2026-06-18 19:35:15 +08:00
const signal = /\n\[killed by signal: ([^\]\n]+)\]$/ . exec ( text )
2026-06-18 18:54:32 +08:00
if ( signal ? . [ 1 ] !== undefined ) return { signal : signal [ 1 ] }
2026-06-18 19:35:15 +08:00
const exit = /\n\[exit code: (\d+)\]$/ . exec ( text )
2026-06-18 18:54:32 +08:00
if ( exit ? . [ 1 ] !== undefined ) return { exitCode : Number ( exit [ 1 ] ) }
return { exitCode : 0 }
}
2026-06-18 09:01:36 +08:00
/** Pending-state presentation for `bash_output`/`bash_kill` (background-task tools). */
2026-07-03 02:04:03 +08:00
function presentTaskCall ( verb : string , args : { task_id : string } ) : GenericCallView {
return { card : 'generic' , title : ` ${ verb } background task ${ args . task_id } ` , kind : 'execute' , rawInput : args.task_id }
2026-06-18 09:01:36 +08:00
}
2026-06-17 10:01:18 +08:00
/**
* Resolve the working directory for a bash call. Precedence: an explicit model
* `workdir` wins; otherwise default to the calling agent's session cwd
* (`session.header.cwd`) so each ACP session's commands run in ITS workspace,
* not the server's launch dir. A RELATIVE model `workdir` is resolved against
* the session cwd (the tool tells the model to pass `workdir` instead of `cd`,
* so a relative one should be relative to the session's root, not `process.cwd()`).
* Returns `undefined` when neither is available (no agent / headerless session /
* no session cwd) — the executor then applies its own config/`process.cwd()`
* default, preserving today's non-ACP behavior.
*/
function resolveWorkdir ( modelWorkdir : string | undefined , exec : { agent? : Agent } ) : string | undefined {
const sessionCwd = exec . agent ? . session . header . cwd
if ( modelWorkdir === undefined ) return sessionCwd
if ( sessionCwd !== undefined && ! isAbsolute ( modelWorkdir ) ) {
return resolvePath ( sessionCwd , modelWorkdir )
}
return modelWorkdir
}
2026-06-12 23:28:44 +08:00
/** Status line for background task reads. */
function statusLine ( task : BashTask ) : string {
switch ( task . status ) {
case 'running' : return '[status: running]'
case 'killed' : return ` [status: killed ${ task . signal !== null ? ` by ${ task . signal } ` : '' } ] `
case 'completed' : return ` [status: completed, exit code: ${ task . exitCode ? ? 0 } ] `
}
}
export function apply ( ctx : Context ) : void {
2026-07-05 01:54:46 +08:00
// The bash tools' cross-call HABIT, which the per-tool descriptions cannot
// carry (they describe one call each): the exit-code marker is only useful
// if the model actually checks it every time.
ctx . systemPrompt . section ( {
name : 'tool:bash' ,
order : 105 ,
text : 'Check the [exit code: N] marker on every bash result; investigate failures before moving on.' ,
} )
2026-06-20 08:14:27 +08:00
/**
2026-07-14 07:26:46 +08:00
* The caller's owner TOKEN — the owning agent's shared registry/session id,
* or `undefined` for a non-agent caller. Agent and Session deliberately have
* one live identity; workdir remains separate session metadata.
2026-06-20 08:14:27 +08:00
*/
2026-06-21 07:17:25 +08:00
const callerToken = ( exec : { agent? : Agent } ) : OwnerToken | undefined = >
2026-07-14 07:26:46 +08:00
exec . agent ? OwnerToken ( exec . agent . id ) : undefined
2026-06-16 19:23:21 +08:00
/**
2026-06-20 08:14:27 +08:00
* Authorize a `bash_output`/`bash_kill` call against the task's stored owner
* token. Rejects when the task HAS an owner and it differs from the caller's
* token — using `!== undefined` semantics, NOT truthiness, so an empty-string
* token is still a real owner (never treated as unowned). An unowned task
* (`ownerOf` returns `undefined`) is allowed; a truly unknown id is also
* `undefined` here and then fails loudly at the subsequent
* `readOutput`/`kill` ("unknown bash task"). The conservative no-agent caller
* (`callerToken` undefined) cannot match an owned task and is rejected.
2026-06-16 19:23:21 +08:00
*/
2026-06-21 07:17:25 +08:00
const assertTaskAccess = ( taskId : BashTaskId , exec : { agent? : Agent } ) : void = > {
2026-06-20 08:14:27 +08:00
const owner = ctx . bash . ownerOf ( taskId )
if ( owner !== undefined && owner !== callerToken ( exec ) ) {
2026-06-16 19:23:21 +08:00
throw new Error ( ` task ${ taskId } belongs to another session ` )
}
}
2026-06-12 23:28:44 +08:00
// Background completion → inject a notice into the owning agent's session.
2026-07-14 07:26:46 +08:00
// Find the live agent by its shared registry/session token, read
2026-06-20 08:14:27 +08:00
// opportunistically with `ctx.get('agents')` (NOT `ctx.agents`/static inject):
// this listener runs from `task.done.then` on the bash fiber — a foreign
// fiber — where the `ctx.agents` property proxy would throw through the
// traceable shadow; `ctx.get(name)` is the topology-independent lookup. No
2026-07-14 07:26:46 +08:00
// registry mounted (`undefined`) → drop the notice.
2026-06-12 23:28:44 +08:00
ctx . bash . onTaskDone ( ( task ) = > {
2026-06-20 08:14:27 +08:00
const ownerToken = ctx . bash . ownerOf ( task . id )
if ( ownerToken === undefined ) return
2026-07-14 07:26:46 +08:00
const agent = ctx . get ( 'agents' ) ? . list ( ) . find ( a = > OwnerToken ( a . id ) === ownerToken )
2026-06-12 23:28:44 +08:00
if ( ! agent ) return
try {
agent . inject (
[ { type : 'text' , text : ` background bash task ${ task . id } finished ${ statusLine ( task ) } . Read its output with bash_output. ` } ] ,
{ source : { kind : 'plugin' , plugin : 'tool-bash' } } ,
)
} catch ( error : unknown ) {
// The ONE expected failure: the agent was disposed between task
2026-06-19 10:13:33 +08:00
// completion and this injection (ReactLoopAgent.inject throws
2026-06-12 23:28:44 +08:00
// `agent "<id>" is disposed`). That race is benign — drop the notice.
// Anything else is a real bug and must surface, not be swallowed.
if ( error instanceof Error && error . message . includes ( 'is disposed' ) ) return
throw error
}
} )
2026-07-11 21:37:38 +08:00
// The escalation surface exists whenever the mounted executor confines.
// Its enum is the closed target vocabulary, deliberately NOT cut down by
// the configured default: a session may switch to a narrower effective mode
// while sharing this globally registered schema. Strict widening therefore
// belongs to the per-call check below. An executor swap restarts this fiber
// (static inject) and re-registers the schema.
2026-07-09 16:37:10 +08:00
const defaultMode = ctx . bash . sandboxMode
const escalationModes : readonly SandboxMode [ ] = defaultMode === undefined ? [ ] : ESCALATION_TARGETS
2026-07-09 16:41:03 +08:00
/**
* The session's standing mode override for an ordinary (non-escalating)
* call: the `bash/sandbox-mode` fold of the calling agent's log, stamped
* onto the request so EXECUTION follows the same effective mode the prompt
* section states. Weakest precedence — an escalation grant (freshly
* approved for exactly this call) outranks it, and without either the
* executor's `resolve()` applies its configured default. Undefined for a
* non-sandboxing executor (nothing honors it) and for agent-less callers
* (no session to fold).
*/
const sessionOverride = ( exec : ToolExecution ) : SandboxMode | undefined = >
defaultMode === undefined || exec . agent === undefined ? undefined : effectiveSandboxMode ( exec . agent . session . events )
2026-07-09 16:37:10 +08:00
/**
* Resolve a sandbox-escalation request through `ctx.approval` BEFORE
* anything executes. Returns the granted mode to stamp onto the bash
* request; throws the distinct fail-closed text for every other path (no
* service composed, an agent-less execution, a rejection, a cancellation,
* an unanswerable ask) — the registry turns the throw into this call's
* isError result, and nothing has run. The seam is consumed
* opportunistically (`ctx.get`, the dsh-tools ask-routing pattern), so a
* deployment without it degrades per call, never at registration.
*/
const approveEscalation = async ( mode : string , justification : string , exec : ToolExecution ) : Promise < SandboxMode > = > {
// Schema validation only checks ADVERTISED keys, so an unadvertised
2026-07-11 21:37:38 +08:00
// `sandbox_permissions` (no sandboxing executor) still reaches execute — reject it here so a
2026-07-09 16:37:10 +08:00
// human is never prompted to "escalate" a sandbox that is not there. When
// the fields ARE advertised, the registry's SchemaSpec enum has already
// pinned `mode` to this ladder for every caller.
if ( escalationModes . length === 0 ) {
throw new Error ( 'sandbox_permissions is not available in this composition (no sandboxing executor to escalate)' )
}
// Strict widening is an EXECUTION check against the call's effective
2026-07-09 16:41:03 +08:00
// mode — session override ?? executor default, the same fold ordinary
// calls are stamped with — deliberately not a schema constraint (the
// enum is the closed target vocabulary; the effective mode is per-call
// truth). A non-widening request fails closed here and never prompts a
// human.
const effectiveMode = ( sessionOverride ( exec ) ? ? defaultMode ) as SandboxMode
2026-07-09 16:37:10 +08:00
if ( ! ( WIDER_MODES [ effectiveMode ] ? ? [ ] ) . includes ( mode as SandboxMode ) ) {
throw new Error ( ` sandbox escalation to " ${ mode } " is not strictly wider than this call's current " ${ effectiveMode } " mode ` )
}
const approval = ctx . get ( 'approval' )
if ( approval === undefined ) {
throw new Error ( ` sandbox escalation to " ${ mode } " requires approval, but no approval service is composed ` )
}
if ( exec . agent === undefined ) {
throw new Error ( ` sandbox escalation to " ${ mode } " requires approval, but the call has no agent to route it through ` )
}
const outcome = await approval . request ( {
agent : exec.agent ,
toolName : 'bash' ,
callId : exec.callId ,
// Self-contained for the audit trail: approval/asked stores this
// reason, and the target mode is part of the grant's identity.
reason : ` escalate sandbox to ${ mode } : ${ justification } ` ,
. . . exec . signal ? { signal : exec.signal } : { } ,
} )
switch ( outcome ) {
2026-07-11 21:37:38 +08:00
// The SchemaSpec enum already pinned `mode` to the closed target
// vocabulary; the per-call check above proved it is strictly wider.
2026-07-09 16:37:10 +08:00
case 'allowed-once' : return mode as SandboxMode
case 'rejected' : throw new Error ( ` the user rejected escalating this command to " ${ mode } " ` )
case 'cancelled' : throw new Error ( ` approval for escalating to " ${ mode } " was cancelled ` )
case 'unavailable' : throw new Error ( ` sandbox escalation to " ${ mode } " requires approval, but no approval channel is available ` )
default : return assertNever ( outcome , 'ApprovalOutcome' )
}
}
2026-06-12 23:28:44 +08:00
ctx . tools . register ( defineTool ( {
name : 'bash' ,
2026-07-09 16:37:10 +08:00
description : bashDescription ( escalationModes ) ,
2026-06-12 23:28:44 +08:00
parameters : {
command : { type : 'string' , required : true , description : 'The bash command to execute.' } ,
description : {
type : 'string' ,
required : true ,
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".' ,
} ,
2026-06-17 21:26:44 +08:00
timeoutMs : { type : 'number' , description : 'Timeout in milliseconds. The executor applies its configured default and cap, and kills the command on expiry.' } ,
2026-06-17 10:01:18 +08:00
workdir : { type : 'string' , description : 'Working directory for this command. Defaults to the session workspace; a relative path is resolved against it.' } ,
2026-06-12 23:28:44 +08:00
run_in_background : { type : 'boolean' , description : 'Run in the background and return a task id immediately. No timeout applies.' } ,
2026-07-09 16:37:10 +08:00
. . . escalationModes . length > 0 ? {
sandbox_permissions : {
type : 'string' as const ,
enum : [ . . . escalationModes ] ,
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.' ,
} ,
justification : {
type : 'string' as const ,
description : 'Required with sandbox_permissions: one sentence for the user explaining '
+ 'why this exact command needs the wider access.' ,
} ,
} : { } ,
2026-06-12 23:28:44 +08:00
} ,
2026-07-09 16:37:10 +08:00
async execute ( args : BashToolArgs , exec ) {
2026-06-12 23:28:44 +08:00
validateBashArgs ( args )
// `description` is display/logging metadata only (surfaced to UIs via
// the tool/call session event); it is intentionally NOT forwarded to
// ctx.bash and has no effect on execution.
2026-07-09 16:37:10 +08:00
// An escalating call resolves approval BEFORE anything executes; every
// non-grant outcome throws its distinct error text and runs nothing.
// (validateBashArgs pinned the pairing, so the double narrow is exact.)
2026-07-09 16:41:03 +08:00
// An ordinary call carries the session's standing override instead —
// grant > session override > executor default (see sessionOverride).
2026-07-09 16:37:10 +08:00
const sandboxMode = args . sandbox_permissions !== undefined && args . justification !== undefined
? await approveEscalation ( args . sandbox_permissions , args . justification , exec )
2026-07-09 16:41:03 +08:00
: sessionOverride ( exec )
2026-06-17 10:01:18 +08:00
// Default the workdir to the calling agent's session cwd so each ACP
// session runs in its own workspace (see resolveWorkdir); an explicit
// model workdir still wins.
const workdir = resolveWorkdir ( args . workdir , exec )
2026-06-12 23:28:44 +08:00
const request = {
command : args.command ,
2026-06-17 10:01:18 +08:00
. . . workdir !== undefined ? { workdir } : { } ,
2026-06-12 23:28:44 +08:00
. . . args . timeoutMs !== undefined ? { timeoutMs : args.timeoutMs } : { } ,
. . . exec . signal ? { signal : exec.signal } : { } ,
2026-07-09 16:37:10 +08:00
. . . sandboxMode !== undefined ? { sandboxMode } : { } ,
2026-06-12 23:28:44 +08:00
}
if ( args . run_in_background === true ) {
2026-06-20 08:14:27 +08:00
// Stamp the owner token (the agent's session id) onto the spec so the
// executor stores it on the task — the isolation fence for bash_output/
// bash_kill. Foreground runs pass no owner (they finish inline; nothing
// to fence).
const task = ctx . bash . start ( ctx . bash . resolve ( { . . . request , owner : callerToken ( exec ) } ) )
2026-06-12 23:28:44 +08:00
return [ { type : 'text' , text : ` started background task ${ task . id } ` } ]
}
const result = await ctx . bash . run ( ctx . bash . resolve ( request ) )
if ( result . aborted ) throw new Error ( 'command aborted' )
2026-07-09 16:37:10 +08:00
return [ { type : 'text' , text : renderResult ( result , escalationModes ) } ]
2026-06-12 23:28:44 +08:00
} ,
2026-06-18 09:01:36 +08:00
presentCall : presentBashCall ,
presentResult : presentBashResult ,
2026-06-12 23:28:44 +08:00
} ) )
ctx . tools . register ( defineTool ( {
name : 'bash_output' ,
description : 'Read new output from a background bash task started with `bash` + `run_in_background`. '
+ 'Returns only output produced since the previous bash_output call, plus the task status. '
+ 'Tasks keep running while you do other work; poll again later for more output.' ,
parameters : {
task_id : { type : 'string' , required : true , description : 'Task id returned by the bash tool.' } ,
} ,
// execute is synchronous (registry reads + string shaping) but the
// ToolDefinition contract wants a Promise — hence resolve(), not async.
2026-06-16 19:23:21 +08:00
execute ( args , exec ) {
const id = validateTaskId ( args . task_id )
assertTaskAccess ( id , exec )
const read = ctx . bash . readOutput ( id )
2026-06-12 23:28:44 +08:00
let text = read . delta . length > 0 ? read . delta : '(no new output)'
if ( read . lossy ) {
const paths = [ read . stdoutSpillPath , read . stderrSpillPath ] . filter ( ( p ) : p is string = > p !== undefined )
2026-06-19 01:54:57 +08:00
const fullOutput = paths . length > 0 ? paths . join ( ', ' ) : '(unavailable)'
text += ` \ n[some output was dropped from memory; full output: ${ fullOutput } ] `
2026-06-12 23:28:44 +08:00
}
text += ` \ n ${ statusLine ( read . task ) } `
2026-07-09 16:05:44 +08:00
if ( read . task . sandbox ? . runnerFailed ) {
// The sandbox RUNNER itself failed — the command never ran. The
// foreground path surfaces this as the structured SANDBOX_UNAVAILABLE
// error; a settled task's read carries the marker instead.
text += ` \ n[sandbox: the sandbox runner itself failed under ${ read . task . sandbox . mode } mode — the command did not run; this is a sandbox problem, not a command failure] `
} else if ( read . task . sandbox ? . denied ) {
2026-07-09 16:37:10 +08:00
// Mirrors the foreground result marker (and its same-turn escalation
// hint). Background denials are only classifiable once the task
// settles (the classifier needs the whole stderr), so the marker
// rides every read that sees the settled task.
2026-07-09 16:05:44 +08:00
text += ` \ n[sandbox: file access denied under ${ read . task . sandbox . mode } mode] `
2026-07-09 16:37:10 +08:00
if ( escalationModes . length > 0 ) {
text += '\n[sandbox: escalation available — retry this exact command once with sandbox_permissions (the narrowest wider mode that suffices) + justification; the approval prompt asks the user]'
}
2026-07-09 16:05:44 +08:00
}
2026-06-12 23:28:44 +08:00
return Promise . resolve ( [ { type : 'text' , text } ] )
} ,
2026-06-18 09:01:36 +08:00
presentCall : args = > presentTaskCall ( 'Read output from' , args ) ,
2026-06-12 23:28:44 +08:00
} ) )
ctx . tools . register ( defineTool ( {
name : 'bash_kill' ,
2026-06-17 21:26:44 +08:00
description : 'Ask the executor to kill a running background bash task by task id.' ,
2026-06-12 23:28:44 +08:00
parameters : {
task_id : { type : 'string' , required : true , description : 'Task id returned by the bash tool.' } ,
} ,
2026-06-16 19:23:21 +08:00
execute ( args , exec ) {
2026-06-12 23:28:44 +08:00
const id = validateTaskId ( args . task_id )
2026-06-16 19:23:21 +08:00
assertTaskAccess ( id , exec )
2026-06-12 23:28:44 +08:00
const killed = ctx . bash . kill ( id )
return Promise . resolve ( [ {
type : 'text' ,
text : killed ? ` killed background task ${ id } ` : ` task ${ id } had already finished ` ,
} ] )
} ,
2026-06-18 09:01:36 +08:00
presentCall : args = > presentTaskCall ( 'Kill' , args ) ,
2026-06-12 23:28:44 +08:00
} ) )
}