SearchToolsOptions
Defined in: packages/tools/src/file/search.ts:16
Shared constructor fields for tools that materialize through an EffectGate.
Extends
Section titled “Extends”Properties
Section titled “Properties”allowRead?
Section titled “allowRead?”
optionalallowRead?:FileAllowRead
Defined in: packages/tools/src/file/search.ts:30
Directories grep’s path may target. Omitted defaults to [root].
import(”../unbounded-allow-read”).UNBOUNDED_ALLOW_READ is host-wide. null
(or []) means nothing can be searched. A list is exactly those roots — root is
not inserted. The executor’s own allowRead is still the subprocess read boundary.
denyRead?
Section titled “denyRead?”
optionaldenyRead?:string[]
Defined in: packages/tools/src/file/search.ts:32
Paths rejected as a grep path, even when they sit inside root or allowRead.
effectGate
Section titled “effectGate”effectGate:
EffectGate
Defined in: packages/tools/src/approval/types.ts:25
Pre-materialize gate. Required — pass import(“@agent-dev-lab/core”).allowAllGate explicitly for tests / permissive local hosts.
Inherited from
Section titled “Inherited from”effectScope
Section titled “effectScope”effectScope:
ToolEffectScope
Defined in: packages/tools/src/approval/types.ts:27
Run identity stamped onto each tool intent.
Inherited from
Section titled “Inherited from”executor
Section titled “executor”executor:
BashExecutor
Defined in: packages/tools/src/file/search.ts:21
Isolation strategy — required: this tool never picks an executor, and there’s no unsandboxed default.
root:
string
Defined in: packages/tools/src/file/search.ts:23
Directory relative search paths resolve against.
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Defined in: packages/tools/src/file/search.ts:34
Wall-clock timeout per search, in milliseconds. Default 30,000 (30s).