0.5.0-SNAPSHOT

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

constructor(fs: FileSystemProvider.ReadWrite<Path>)

Types

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

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

object Companion

Descriptor for the edit file tool.

data class Result(patchApplyResult: PatchApplyResult) : ToolResult.TextSerializable

Result of applying the edit patch to the target file.

Properties

open override val argsSerializer: KSerializer<EditFileTool.Args>

open override val description: String

open override val descriptor: ToolDescriptor

open override val name: String

resultSerializer

open override val resultSerializer: KSerializer<EditFileTool.Result>

Functions

fun decodeArgs(rawArgs: JsonObject): EditFileTool.Args

fun encodeArgs(args: EditFileTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: EditFileTool.Args): String

encodeResultToString

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

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

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

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