FileToolsOptions

Defined in: packages/tools/src/file/tools.ts:21

Shared constructor fields for tools that materialize through an EffectGate.

Extends

• GatedToolOptions

Properties

allowRead?

optional allowRead?: FileAllowRead

Defined in: packages/tools/src/file/tools.ts:33

Directories readFile may read. Omitted defaults to [root] (same as createFileJail). import(”../unbounded-allow-read.ts”).UNBOUNDED_ALLOW_READ is host-wide. null (or []) means nothing can be read. A list is exactly those roots — root is not inserted. denyRead still wins.

---

allowWrite?

optional allowWrite?: string[]

Defined in: packages/tools/src/file/tools.ts:38

Write allow list. Omitted → [root]. [] — no writes. A list is exactly those roots (no intersection with a privileged root).

---

denyRead?

optional denyRead?: string[]

Defined in: packages/tools/src/file/tools.ts:40

Paths hidden from readFile, even when they sit inside root or allowRead.

---

denyWrite?

optional denyWrite?: string[]

Defined in: packages/tools/src/file/tools.ts:42

Paths writeFile / editFile may not write, even under allowWrite.

---

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

GatedToolOptions.effectGate

---

effectScope

effectScope: ToolEffectScope

Defined in: packages/tools/src/approval/types.ts:27

Run identity stamped onto each tool intent.

Inherited from

GatedToolOptions.effectScope

---

maxReadBytes?

optional maxReadBytes?: number

Defined in: packages/tools/src/file/tools.ts:44

Refuse to read a file over this many bytes. Default 1,000,000 (1 MB).

---

maxWriteBytes?

optional maxWriteBytes?: number

Defined in: packages/tools/src/file/tools.ts:46

Refuse to write more than this many bytes. Default 1,000,000 (1 MB).

---

root

root: string

Defined in: packages/tools/src/file/tools.ts:26

Relative-path base and omit-default for allow lists (passed to the jail as cwd). Required so factories do not silently fall back to the home directory.