Skip to content

WorkspaceToolProviderOptions

Defined in: workspace/provider.ts:107

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

Defined in: workspace/provider.ts:95

Overrides options.allowedUrls for this call — see WebToolProviderContext.allowedUrls.

WorkspaceToolProviderContext.allowedUrls


optional allowPrivateNetwork?: boolean

Defined in: workspace/provider.ts:97

Overrides options.allowPrivateNetwork for this call.

WorkspaceToolProviderContext.allowPrivateNetwork


optional bashTimeoutMs?: number

Defined in: workspace/provider.ts:89

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

WorkspaceToolProviderContext.bashTimeoutMs


optional cwd?: string

Defined in: workspace/provider.ts:87

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

WorkspaceToolProviderContext.cwd


executor: BashExecutor

Defined in: workspace/provider.ts:109

Isolation strategy for the bash tool. Required — there is no unsandboxed default.


optional fetchTimeoutMs?: number

Defined in: workspace/provider.ts:100

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

WorkspaceToolProviderContext.fetchTimeoutMs


optional fetchUrl?: boolean

Defined in: workspace/provider.ts:122

Include fetchUrl. Default true. Set false to omit the tool from listTools / getTools. 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.


optional maxReadBytes?: number

Defined in: workspace/provider.ts:91

Overrides options.maxReadBytes for this call.

WorkspaceToolProviderContext.maxReadBytes


optional maxRedirects?: number

Defined in: workspace/provider.ts:104

Overrides options.maxRedirects for this call.

WorkspaceToolProviderContext.maxRedirects


optional maxResponseBytes?: number

Defined in: workspace/provider.ts:102

Overrides options.maxResponseBytes for this call.

WorkspaceToolProviderContext.maxResponseBytes


optional maxWriteBytes?: number

Defined in: workspace/provider.ts:93

Overrides options.maxWriteBytes for this call.

WorkspaceToolProviderContext.maxWriteBytes


optional resolver?: HostnameResolver

Defined in: workspace/provider.ts:114

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


optional safetyCheck?: BashSafetyCheckWorkflow

Defined in: workspace/provider.ts:112

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