0.5.0-SNAPSHOT

agents-ext/ai.koog.agents.ext.tool.file/ReadFileTool

ReadFileTool

class ReadFileTool<Path>(fs: FileSystemProvider.ReadOnly<Path>) : Tool<ReadFileTool.Args, ReadFileTool.Result> (source)

Provides functionality to read file contents with configurable start and end line parameters, returning structured file metadata and content.

Parameters

Path

the filesystem path type used by the provider

Constructors

constructor(fs: FileSystemProvider.ReadOnly<Path>)

Types

data class Args(val path: String, val startLine: Int = 0, val endLine: Int = -1)

Specifies which file to read and what portion of its content to extract.

data class Result(val file: FileSystemEntry.File) : ToolResult.TextSerializable

Contains the successfully read file with its metadata and extracted content.

Properties

open override val argsSerializer: KSerializer<ReadFileTool.Args>

open override val description: String

open val descriptor: ToolDescriptor

open override val name: String

resultSerializer

open override val resultSerializer: KSerializer<ReadFileTool.Result>

Functions

fun decodeArgs(rawArgs: JsonObject): ReadFileTool.Args

fun encodeArgs(args: ReadFileTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: ReadFileTool.Args): String

encodeResultToString

open fun encodeResultToString(result: ReadFileTool.Result): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

suspend fun execute(args: ReadFileTool.Args, enabler: DirectToolCallsEnabler): ReadFileTool.Result

suspend fun executeUnsafe(args: Any?, enabler: DirectToolCallsEnabler): ReadFileTool.Result