Skip to content

Interface: FsReadToolNode<THandle> ​

Defined in: ast/domain/fs-read-tool-node.ts:12

Passive AST node for the workspace-jailed file reading tool (fs:read).

Reads UTF-8 file contents within the active isolation scope worktree and emits a declared FsToolEffect read record for policy guard and read-before-write tracking.

Extends ​

Type Parameters ​

Type ParameterDefault typeDescription
THandleunknownIsolation scope handle type.

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
__handleBrand?readonlyBivariantCallback<[handle: THandle], void>Phantom type brand binding the tool to its compatible scope handle type.BaseToolASTNode.__handleBrandast/base/base-tool-ast-node.ts:30
descriptionreadonlystringHuman- and LLM-readable description of the tool's behavior.BaseToolASTNode.descriptionast/base/base-tool-ast-node.ts:24
effectTrackingreadonly"declared"Static indicator of whether effects are predicted pre-flight or diffed post-flight.BaseToolASTNode.effectTrackingast/base/base-tool-ast-node.ts:28
inputSchemareadonlyZodTypeAnyZod schema validating tool call arguments before execution.BaseToolASTNode.inputSchemaast/base/base-tool-ast-node.ts:26
namereadonlystringWire-level tool function name exposed to the LLM.BaseToolASTNode.nameast/base/base-tool-ast-node.ts:22
runnerreadonlyNodeRunnerNodeRunner pool associated with the filesystem tool bundle.-ast/domain/fs-read-tool-node.ts:15
typereadonly"fs:read"Unique string-literal discriminant of the tool node.BaseToolASTNode.typeast/base/base-tool-ast-node.ts:20

Released under the MIT License.