|
|
@@ -55,8 +55,10 @@
|
|
|
* @module @deepseek-ai/dsh-tool-bash
|
|
|
*/
|
|
|
|
|
|
-import type { Context } from 'cordis'
|
|
|
-import { isAbsolute, resolve as resolvePath } from 'node:path'
|
|
|
+import { Service, type Context } from 'cordis'
|
|
|
+import z from 'schemastery'
|
|
|
+import { homedir } from 'node:os'
|
|
|
+import { isAbsolute, join, resolve as resolvePath } from 'node:path'
|
|
|
import { defineTool } from '@deepseek-ai/dsh-tools'
|
|
|
import type { GenericCallView, TerminalCallView, ToolExecution, ToolResult, ToolResultView } from '@deepseek-ai/dsh-tools'
|
|
|
import type { Agent } from '@deepseek-ai/dsh-agent'
|
|
|
@@ -69,11 +71,178 @@ import type {} from '@deepseek-ai/dsh-system-prompt'
|
|
|
import type {} from '@deepseek-ai/dsh-user-approval'
|
|
|
import type { SandboxMode } from '@deepseek-ai/dsh-sandbox'
|
|
|
import { BashTaskId, OwnerToken, effectiveSandboxMode } from '@deepseek-ai/dsh-bash'
|
|
|
-import type { BashRunResult, BashTask, CollectedOutput } from '@deepseek-ai/dsh-bash'
|
|
|
+import type { BashRunResult, BashTask, CollectedOutput, DshEnvironment } from '@deepseek-ai/dsh-bash'
|
|
|
+
|
|
|
+declare module 'cordis' {
|
|
|
+ interface Context {
|
|
|
+ bashEnv: BashEnvRegistry
|
|
|
+ }
|
|
|
+}
|
|
|
|
|
|
export const name = 'tool-bash'
|
|
|
export const inject = ['tools', 'bash', 'systemPrompt']
|
|
|
|
|
|
+/** Configuration for the bash tool and its managed child environment. */
|
|
|
+export interface Config {
|
|
|
+ /** DeepSeek Harness home directory exposed as `DSH_HOME`; defaults to `$DSH_HOME` or `~/.dsh`. */
|
|
|
+ dshHome?: string
|
|
|
+}
|
|
|
+
|
|
|
+/** Runtime configuration schema for the bash tool plugin. */
|
|
|
+export const Config: z<Config> = z.object({
|
|
|
+ dshHome: z.string(),
|
|
|
+})
|
|
|
+
|
|
|
+/** Model-visible metadata for one managed `DSH_*` environment variable. */
|
|
|
+export interface BashEnvVariable {
|
|
|
+ /** Concise description of the environment fact represented by the variable. */
|
|
|
+ description: string
|
|
|
+}
|
|
|
+
|
|
|
+/**
|
|
|
+ * A plugin contribution to the managed environment of each model bash call.
|
|
|
+ * Declared keys make ownership conflicts detectable before the first command;
|
|
|
+ * `resolve` computes only the values available for the current execution.
|
|
|
+ */
|
|
|
+export interface BashEnvContributor {
|
|
|
+ /** Stable contributor name used in diagnostics and duplicate detection. */
|
|
|
+ name: string
|
|
|
+ /** Complete set of `DSH_*` keys this contributor may return. */
|
|
|
+ variables: Readonly<Record<`DSH_${string}`, BashEnvVariable>>
|
|
|
+ /**
|
|
|
+ * Resolve this contributor's available values for one tool execution.
|
|
|
+ * @param execution - the bash tool execution and its optional calling agent.
|
|
|
+ * @returns a partial map containing only keys declared in {@link variables}.
|
|
|
+ */
|
|
|
+ resolve(execution: ToolExecution): Readonly<Partial<Record<`DSH_${string}`, string>>>
|
|
|
+}
|
|
|
+
|
|
|
+/** An enumerable declaration returned by {@link BashEnvRegistry.list}. */
|
|
|
+export interface BashEnvVariableInfo extends BashEnvVariable {
|
|
|
+ /** Contributor that owns the variable. */
|
|
|
+ contributor: string
|
|
|
+ /** Declared `DSH_*` environment variable name. */
|
|
|
+ key: `DSH_${string}`
|
|
|
+}
|
|
|
+
|
|
|
+const RESERVED_BASH_ENV_KEYS = new Set<`DSH_${string}`>([
|
|
|
+ 'DSH_HOME',
|
|
|
+ 'DSH_SHELL',
|
|
|
+ 'DSH_SESSION_ID',
|
|
|
+])
|
|
|
+const BASH_ENV_KEY = /^DSH_[A-Z][A-Z0-9_]*$/
|
|
|
+
|
|
|
+/**
|
|
|
+ * Registry (`ctx.bashEnv`) for trusted, per-execution `DSH_*` variables.
|
|
|
+ * The namespace is rebuilt for every model bash call: ambient `DSH_*` values
|
|
|
+ * are discarded by the executor, then the registry's current snapshot is
|
|
|
+ * injected. Built-in shell facts remain owned by the registry itself while
|
|
|
+ * plugins can register additional, enumerable facts with effect-scoped
|
|
|
+ * disposal.
|
|
|
+ */
|
|
|
+export class BashEnvRegistry extends Service {
|
|
|
+ private readonly contributors = new Map<string, BashEnvContributor>()
|
|
|
+ private readonly keyOwners = new Map<`DSH_${string}`, string>()
|
|
|
+ private readonly dshHome: string
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Create and install the `ctx.bashEnv` service.
|
|
|
+ * @param ctx - Cordis context that owns the service and registrations.
|
|
|
+ * @param config - home-directory configuration for the built-in variables.
|
|
|
+ */
|
|
|
+ constructor(ctx: Context, config: Config = {}) {
|
|
|
+ super(ctx, 'bashEnv')
|
|
|
+ this.dshHome = resolvePath(config.dshHome ?? process.env.DSH_HOME ?? join(homedir(), '.dsh'))
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Register one environment contributor. Names and keys are unique; built-in
|
|
|
+ * keys are reserved. Registration is disposed with the calling plugin fiber.
|
|
|
+ * @param contributor - declared key ownership and per-execution resolver.
|
|
|
+ * @returns the disposer that unregisters the contribution.
|
|
|
+ */
|
|
|
+ register(contributor: BashEnvContributor): () => void {
|
|
|
+ const dispose = this.ctx.effect(function* (this: BashEnvRegistry) {
|
|
|
+ if (contributor.name.trim().length === 0) {
|
|
|
+ throw new Error('bash env contributor name must be non-empty')
|
|
|
+ }
|
|
|
+ if (this.contributors.has(contributor.name)) {
|
|
|
+ throw new Error(`bash env contributor "${contributor.name}" is already registered`)
|
|
|
+ }
|
|
|
+
|
|
|
+ const variables = Object.entries(contributor.variables) as [`DSH_${string}`, BashEnvVariable][]
|
|
|
+ for (const [key, variable] of variables) {
|
|
|
+ if (!BASH_ENV_KEY.test(key)) {
|
|
|
+ throw new Error(`bash env contributor "${contributor.name}" declared invalid key "${key}"`)
|
|
|
+ }
|
|
|
+ if (RESERVED_BASH_ENV_KEYS.has(key)) {
|
|
|
+ throw new Error(`bash env contributor "${contributor.name}" cannot own reserved key "${key}"`)
|
|
|
+ }
|
|
|
+ if (variable.description.trim().length === 0) {
|
|
|
+ throw new Error(`bash env contributor "${contributor.name}" must describe "${key}"`)
|
|
|
+ }
|
|
|
+ const owner = this.keyOwners.get(key)
|
|
|
+ if (owner !== undefined) {
|
|
|
+ throw new Error(`bash env key "${key}" is already owned by contributor "${owner}"; contributor "${contributor.name}" cannot also own it`)
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ this.contributors.set(contributor.name, contributor)
|
|
|
+ for (const [key] of variables) this.keyOwners.set(key, contributor.name)
|
|
|
+ yield () => {
|
|
|
+ this.contributors.delete(contributor.name)
|
|
|
+ for (const [key] of variables) this.keyOwners.delete(key)
|
|
|
+ }
|
|
|
+ }.bind(this), 'bashEnv.register()')
|
|
|
+ return () => void dispose()
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Build the trusted `DSH_*` snapshot for one bash tool execution.
|
|
|
+ * @param execution - the current tool execution.
|
|
|
+ * @returns an immutable environment overlay containing built-ins and current contributions.
|
|
|
+ */
|
|
|
+ collect(execution: ToolExecution): DshEnvironment {
|
|
|
+ const values: Record<`DSH_${string}`, string> = {
|
|
|
+ DSH_HOME: this.dshHome,
|
|
|
+ DSH_SHELL: '1',
|
|
|
+ }
|
|
|
+ if (execution.agent !== undefined) {
|
|
|
+ values.DSH_SESSION_ID = execution.agent.session.header.id
|
|
|
+ }
|
|
|
+
|
|
|
+ for (const contributor of [...this.contributors.values()].sort((left, right) => left.name.localeCompare(right.name))) {
|
|
|
+ const resolved = contributor.resolve(execution)
|
|
|
+ for (const [rawKey, value] of Object.entries(resolved)) {
|
|
|
+ const key = rawKey as `DSH_${string}`
|
|
|
+ if (!Object.hasOwn(contributor.variables, key)) {
|
|
|
+ throw new Error(`bash env contributor "${contributor.name}" returned undeclared key "${key}"`)
|
|
|
+ }
|
|
|
+ if (typeof value !== 'string') {
|
|
|
+ throw new Error(`bash env contributor "${contributor.name}" returned a non-string value for "${key}"`)
|
|
|
+ }
|
|
|
+ values[key] = value
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ return Object.freeze(Object.fromEntries(Object.entries(values).sort(([left], [right]) => left.localeCompare(right))))
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Enumerate plugin-contributed variables without executing their resolvers.
|
|
|
+ * @returns declarations sorted by environment variable name.
|
|
|
+ */
|
|
|
+ list(): BashEnvVariableInfo[] {
|
|
|
+ return [...this.contributors.values()]
|
|
|
+ .flatMap(contributor => Object.entries(contributor.variables).map(([key, variable]) => ({
|
|
|
+ contributor: contributor.name,
|
|
|
+ description: variable.description,
|
|
|
+ key: key as `DSH_${string}`,
|
|
|
+ })))
|
|
|
+ .sort((left, right) => left.key.localeCompare(right.key))
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
/**
|
|
|
* Validate the constraints the SchemaSpec can't express. `defineTool` now
|
|
|
* validates parsed args against the SchemaSpec before `execute` runs (the
|
|
|
@@ -168,8 +337,7 @@ 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]`. '
|
|
|
- + 'The current agent session id is available as `$DSH_SESSION_ID`; when JSONL persistence is configured, '
|
|
|
- + '`$DSH_SESSION_JSONL` is its absolute target path and may not exist or contain the current unflushed turn yet. '
|
|
|
+ + '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 (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; '
|
|
|
@@ -397,22 +565,6 @@ function resolveWorkdir(modelWorkdir: string | undefined, exec: { agent?: Agent
|
|
|
return modelWorkdir
|
|
|
}
|
|
|
|
|
|
-/**
|
|
|
- * Build the trusted per-execution session environment. Identity always comes
|
|
|
- * from the calling agent's immutable session header; an optional JSONL path
|
|
|
- * comes from the active persistence backend's side-effect-free locator. A
|
|
|
- * non-agent caller has no current session, so it receives neither variable.
|
|
|
- */
|
|
|
-function sessionEnvironment(ctx: Context, exec: { agent?: Agent }): Record<string, string> | undefined {
|
|
|
- const agent = exec.agent
|
|
|
- if (agent === undefined) return undefined
|
|
|
-
|
|
|
- const env: Record<string, string> = { DSH_SESSION_ID: agent.session.header.id }
|
|
|
- const location = ctx.get('sessionPersistence')?.locate(agent.session.header)
|
|
|
- if (location?.kind === 'jsonl') env.DSH_SESSION_JSONL = location.path
|
|
|
- return env
|
|
|
-}
|
|
|
-
|
|
|
/** Status line for background task reads. */
|
|
|
function statusLine(task: BashTask): string {
|
|
|
switch (task.status) {
|
|
|
@@ -422,7 +574,23 @@ function statusLine(task: BashTask): string {
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-export function apply(ctx: Context): void {
|
|
|
+export function apply(ctx: Context, config: Config = {}): void {
|
|
|
+ const bashEnv = new BashEnvRegistry(ctx, config)
|
|
|
+ bashEnv.register({
|
|
|
+ name: 'session-persistence',
|
|
|
+ variables: {
|
|
|
+ DSH_SESSION_JSONL: {
|
|
|
+ description: 'Absolute target path of the current session JSONL when the active persistence backend provides one.',
|
|
|
+ },
|
|
|
+ },
|
|
|
+ resolve(execution) {
|
|
|
+ const agent = execution.agent
|
|
|
+ if (agent === undefined) return {}
|
|
|
+ const location = ctx.get('sessionPersistence')?.locate(agent.session.header)
|
|
|
+ return location?.kind === 'jsonl' ? { DSH_SESSION_JSONL: location.path } : {}
|
|
|
+ },
|
|
|
+ })
|
|
|
+
|
|
|
// 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.
|
|
|
@@ -614,13 +782,13 @@ export function apply(ctx: Context): void {
|
|
|
// session runs in its own workspace (see resolveWorkdir); an explicit
|
|
|
// model workdir still wins.
|
|
|
const workdir = resolveWorkdir(args.workdir, exec)
|
|
|
- const env = sessionEnvironment(ctx, exec)
|
|
|
+ const dshEnv = bashEnv.collect(exec)
|
|
|
const request = {
|
|
|
command: args.command,
|
|
|
...workdir !== undefined ? { workdir } : {},
|
|
|
...args.timeoutMs !== undefined ? { timeoutMs: args.timeoutMs } : {},
|
|
|
...exec.signal ? { signal: exec.signal } : {},
|
|
|
- ...env !== undefined ? { env } : {},
|
|
|
+ dshEnv,
|
|
|
...sandboxMode !== undefined ? { sandboxMode } : {},
|
|
|
}
|
|
|
if (args.run_in_background === true) {
|