apollo-code

---

apollo-code / tools/src / ReadTool

Class: ReadTool

Implements

• Tool<{ limit?: number; offset?: number; path: string; }>

Constructors

Constructor

new ReadTool(): ReadTool

Returns

ReadTool

Properties

description

readonly description: "Read a UTF-8 file" = 'Read a UTF-8 file'

Implementation of

Tool.description

---

inputSchema

readonly inputSchema: never

Implementation of

Tool.inputSchema

---

name

readonly name: "Read" = 'Read'

Implementation of

Tool.name

---

parallelSafe

readonly parallelSafe: true = true

Implementation of

Tool.parallelSafe

---

readonly

readonly readonly: true = true

Implementation of

Tool.readonly

Methods

invoke()

invoke(input, ctx): Promise<ToolResult>

Parameters

input

limit?

number

offset?

number

path

string

ctx

ToolContext

Returns

Promise<ToolResult>

Implementation of

Tool.invoke

---

permissionSpec()

permissionSpec(input): PermissionSpec

Parameters

input

path

string

Returns

PermissionSpec

Implementation of

Tool.permissionSpec