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

EditFileTool

class EditFileTool<Path>(fs: FileSystemProvider.ReadWrite<Path>) : Tool<EditFileTool.Args, EditFileTool.Result> (source)

Tool to enable the agent to edit files.

Takes a file path and two strings: original and replacement. And searches for the original string in the file and replaces it with the replacement.

Also handles case and white space mismatches in the original string.

Constructors

EditFileTool

constructor(fs: FileSystemProvider.ReadWrite<Path>)

Types

Args

@Serializable

data class Args(val path: String, val original: String, val replacement: String)

Arguments required to perform a single edit operation on a file.

Companion

object Companion

Descriptor for the edit file tool.

Result

@Serializable

data class Result(val patchApplyResult: PatchApplyResult)

Result of applying the edit patch to the target file.

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): EditFileTool.Args

decodeResult

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

encodeArgs

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

encodeArgsToString

fun encodeArgsToString(args: EditFileTool.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: EditFileTool.Result, serializer: JSONSerializer): JSONElement

encodeResultToString

open override fun encodeResultToString(result: EditFileTool.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: EditFileTool.Args): EditFileTool.Result

executeUnsafe

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