ReadFileTool
Generated by TypeDoc. Do not edit this page directly.
Class: ReadFileTool
Section titled “Class: ReadFileTool”Defined in: packages/tools-node/src/files.ts:86
Extends
Section titled “Extends”HarnessTool<ReadFileInput>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ReadFileTool(): ReadFileTool;Returns
Section titled “Returns”ReadFileTool
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”| Property | Type | Default value | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
approvalTimeoutMs? | number | undefined | - | HarnessTool.approvalTimeoutMs | packages/core/src/runtime/types/tools.ts:55 |
description | string | "Read a UTF-8 text file inside the harness workDir." | HarnessTool.description | - | packages/tools-node/src/files.ts:88 |
label? | string | undefined | - | HarnessTool.label | packages/core/src/runtime/types/tools.ts:48 |
name | string | "read_file" | HarnessTool.name | - | packages/tools-node/src/files.ts:87 |
permissions | object[] | undefined | HarnessTool.permissions | - | packages/tools-node/src/files.ts:91 |
requiresApproval? | | boolean | ToolApprovalResolver | undefined | - | HarnessTool.requiresApproval | packages/core/src/runtime/types/tools.ts:54 |
risk | "read" | undefined | HarnessTool.risk | - | packages/tools-node/src/files.ts:90 |
schema | ObjectSchema<{ maxBytes: OptionalSchema<unknown, number | undefined>; path: StringSchema; }> | readFileSchema | HarnessTool.schema | - | packages/tools-node/src/files.ts:89 |
Accessors
Section titled “Accessors”inputSchema
Section titled “inputSchema”Get Signature
Section titled “Get Signature”get inputSchema(): unknown;Defined in: packages/core/src/runtime/types/tools.ts:61
Returns
Section titled “Returns”unknown
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get type(): string;Defined in: packages/core/src/runtime/types/tools.ts:57
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”execute()
Section titled “execute()”execute(args, session): Promise<AgentToolResult<unknown>>;Defined in: packages/tools-node/src/files.ts:93
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | ObjectInput |
session | AgentActionSession |
Returns
Section titled “Returns”Promise<AgentToolResult<unknown>>