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.

Type Parameters

Path

the filesystem path type used by the provider

Constructors

ReadFileTool

constructor(fs: FileSystemProvider.ReadOnly<Path>)

Types

Args

@Serializable

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.

Result

@Serializable

data class Result(val file: FileSystemEntry.File, val warningMessage: String? = null)

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

Properties

argsType

val argsType: TypeToken

descriptor

val descriptor: ToolDescriptor

metadata

val metadata: Map<String, String>

name

val name: String

resultType

val resultType: TypeToken

Functions

decodeArgs

open fun decodeArgs(rawArgs: JSONObject, serializer: JSONSerializer): ReadFileTool.Args

decodeResult

open fun decodeResult(rawResult: JSONElement, serializer: JSONSerializer): ReadFileTool.Result

encodeArgs

open fun encodeArgs(args: ReadFileTool.Args, serializer: JSONSerializer): JSONObject

encodeArgsToString

fun encodeArgsToString(args: ReadFileTool.Args, serializer: JSONSerializer): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?, serializer: JSONSerializer): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?, serializer: JSONSerializer): JSONObject

encodeResult

open fun encodeResult(result: ReadFileTool.Result, serializer: JSONSerializer): JSONElement

encodeResultToString

open override fun encodeResultToString(result: ReadFileTool.Result, serializer: JSONSerializer): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?, serializer: JSONSerializer): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?, serializer: JSONSerializer): JSONElement

execute

open suspend override fun execute(args: ReadFileTool.Args): ReadFileTool.Result

Reads file content from the filesystem with optional line range filtering.

executeUnsafe

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