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

WriteFileTool

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

Provides functionality to write text content to files at absolute paths, creating parent directories and overwriting existing content as needed.

Type Parameters

Path

the filesystem path type used by the provider

Constructors

WriteFileTool

constructor(fs: FileSystemProvider.ReadWrite<Path>)

Types

Args

@Serializable

data class Args(val path: String, val content: String)

Specifies which file to write and what text content to put into it.

Result

@Serializable

data class Result(val file: FileSystemEntry.File)

Contains the successfully written file with its metadata.

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

decodeResult

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

encodeArgs

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

encodeArgsToString

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

encodeResultToString

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

Writes text content to the filesystem at the specified absolute path.

executeUnsafe

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