WorkspaceToolProviderOptions

Defined in: packages/tools/src/workspace/provider.ts:172

Extends

• WorkspaceToolProviderContext

Properties

allowedDomains?

optional allowedDomains?: string[]

Defined in: packages/tools/src/bash/executor-pool.ts:30

Inherited from

BashSandboxPolicy.allowedDomains

---

allowedUrls?

optional allowedUrls?: readonly (string | RegExp)[]

Defined in: packages/tools/src/web/provider.ts:96

Inherited from

WorkspaceToolProviderContext.allowedUrls

---

allowEnv?

optional allowEnv?: AllowEnv

Defined in: packages/tools/src/bash/executor-pool.ts:37

Host env vars exposed inside the sandbox. Omitted / [] → none. Part of the pool key.

Inherited from

BashSandboxPolicy.allowEnv

---

allowNetwork?

optional allowNetwork?: boolean

Defined in: packages/tools/src/bash/executor-pool.ts:33

Master network switch. Domain lists apply only when this is true.

Inherited from

BashSandboxPolicy.allowNetwork

---

allowPrivateNetwork?

optional allowPrivateNetwork?: boolean

Defined in: packages/tools/src/web/provider.ts:102

Inherited from

WorkspaceToolProviderContext.allowPrivateNetwork

---

allowRead?

optional allowRead?: "**" | string[] | null

Defined in: packages/tools/src/bash/executor-pool.ts:27

Paths reads are confined to. After provider merge: a list, UNBOUNDED_ALLOW_READ for host-wide, or null/[] for nothing readable. On options/context before merge, omit to default to [cwd].

Inherited from

BashSandboxPolicy.allowRead

---

allowWrite?

optional allowWrite?: string[]

Defined in: packages/tools/src/bash/executor-pool.ts:21

Inherited from

BashSandboxPolicy.allowWrite

---

backend?

optional backend?: BashSandboxBackend

Defined in: packages/tools/src/workspace/provider.ts:185

Sandbox backend when using the pool. Default "asrt". Invalid with executor.

---

bashTimeoutMs?

optional bashTimeoutMs?: number

Defined in: packages/tools/src/workspace/provider.ts:162

Overrides options.bashTimeoutMs for this call — bash (and search) only, never fetchUrl.

Inherited from

WorkspaceToolProviderContext.bashTimeoutMs

---

cwd?

optional cwd?: string

Defined in: packages/tools/src/workspace/provider.ts:160

Overrides options.cwd for this call — drives both the file jail root and the bash cwd.

Inherited from

WorkspaceToolProviderContext.cwd

---

deniedDomains?

optional deniedDomains?: string[]

Defined in: packages/tools/src/bash/executor-pool.ts:31

Inherited from

BashSandboxPolicy.deniedDomains

---

denyRead?

optional denyRead?: string[]

Defined in: packages/tools/src/bash/executor-pool.ts:28

Inherited from

BashSandboxPolicy.denyRead

---

denyWrite?

optional denyWrite?: string[]

Defined in: packages/tools/src/bash/executor-pool.ts:29

Inherited from

BashSandboxPolicy.denyWrite

---

effectGate

effectGate: EffectGate

Defined in: packages/tools/src/workspace/provider.ts:177

Pre-materialize gate for every workspace tool. Required — pass import(“@agent-dev-lab/core”).allowAllGate explicitly for tests / playground.

---

executor?

optional executor?: BashExecutor

Defined in: packages/tools/src/workspace/provider.ts:183

Isolation strategy for the bash / search tools. Optional when policy (allowWrite, …) is provided — acquires from the process pool. Escape hatch; mutually exclusive with policy fields and backend.

---

fetchTimeoutMs?

optional fetchTimeoutMs?: number

Defined in: packages/tools/src/workspace/provider.ts:169

Overrides options.fetchTimeoutMs for this call — fetchUrl only, never bash. Named apart from bashTimeoutMs so the two independent knobs cannot collide.

Inherited from

WorkspaceToolProviderOptions.fetchTimeoutMs

---

fetchUrl?

optional fetchUrl?: boolean

Defined in: packages/tools/src/workspace/provider.ts:199

Include fetchUrl. Default is to include it only when WorkspaceToolProviderOptions.allowNetwork (or this call’s toolProviderContext.allowNetwork) is true. Set false to omit the tool even when network is allowed. Empty allowedUrls is not a deny — public http(s) still works — so it does not remove the tool. Fetch options (allowedUrls, allowPrivateNetwork, fetchTimeoutMs, maxResponseBytes, maxRedirects, resolver) and the matching toolProviderContext fields are rejected when this is false.

---

maxReadBytes?

optional maxReadBytes?: number

Defined in: packages/tools/src/workspace/provider.ts:164

Overrides options.maxReadBytes for this call.

Inherited from

WorkspaceToolProviderContext.maxReadBytes

---

maxRedirects?

optional maxRedirects?: number

Defined in: packages/tools/src/web/provider.ts:105

Inherited from

WorkspaceToolProviderContext.maxRedirects

---

maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/tools/src/web/provider.ts:104

Inherited from

WorkspaceToolProviderContext.maxResponseBytes

---

maxWriteBytes?

optional maxWriteBytes?: number

Defined in: packages/tools/src/workspace/provider.ts:166

Overrides options.maxWriteBytes for this call.

Inherited from

WorkspaceToolProviderContext.maxWriteBytes

---

resolver?

optional resolver?: HostnameResolver

Defined in: packages/tools/src/workspace/provider.ts:190

Hostname resolver override, fixed at construction time — see FetchUrlToolOptions.

---

safetyCheck?

optional safetyCheck?: BashSafetyCheckWorkflow

Defined in: packages/tools/src/workspace/provider.ts:188

Optional AI-based safety check layered on top of the bash sandbox — see BashSafetyCheckWorkflow’s doc comment.

---

tmpDir?

optional tmpDir?: string

Defined in: packages/tools/src/bash/executor-pool.ts:42

ASRT-only. Directory used as TMPDIR inside the sandbox. Omitted → the executor creates a per-instance directory. Native backend rejects this field.

Inherited from

BashSandboxPolicy.tmpDir