Class FileReadTool

Tool for reading files

Implements

IAuthService

Index

Constructors

Properties

category description displayName hasSideEffects id inputSchema name

Methods

execute validateArgs

Constructors

constructor

new FileReadTool(shellService: ShellService): FileReadTool
Parameters
- shellService: ShellService
Returns FileReadTool
- Defined in system/cli-executor/src/tools/fileRead.ts:57

Properties

`Readonly`category

category: "system" = 'system'

`Readonly`description

description: "Read the contents of a file from disk." = 'Read the contents of a file from disk.'

`Readonly`displayName

displayName: "Read File" = 'Read File'

`Readonly`hasSideEffects

hasSideEffects: false

`Readonly`id

id: "cli-file-read-v1" = 'cli-file-read-v1'

`Readonly`inputSchema

inputSchema: JSONSchemaObject = ...

`Readonly`name

name: "file_read" = 'file_read'

Tool call name used by the LLM / ToolExecutor.

Methods

execute

execute(
    input: {
        encoding?: BufferEncoding;
        fromEnd?: boolean;
        lines?: number;
        maxBytes?: number;
        path: string;
    },
    _context: ToolExecutionContext,
): Promise<ToolExecutionResult<FileReadResult>>
Read file
Parameters
- input: {
      encoding?: BufferEncoding;
      fromEnd?: boolean;
      lines?: number;
      maxBytes?: number;
      path: string;
  }
- _context: ToolExecutionContext
Returns Promise<ToolExecutionResult<FileReadResult>>
- Defined in system/cli-executor/src/tools/fileRead.ts:62

validateArgs

validateArgs(input: Record<string, any>): { errors?: any[]; isValid: boolean }
Validate input
Parameters
- input: Record<string, any>
Returns { errors?: any[]; isValid: boolean }
- Defined in system/cli-executor/src/tools/fileRead.ts:112