0.5.0-SNAPSHOT

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.

Parameters

Path

the filesystem path type used by the provider

Constructors

constructor(fs: FileSystemProvider.ReadWrite<Path>)

Types

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

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

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

Contains the successfully written file with its metadata.

Properties

open override val argsSerializer: KSerializer<WriteFileTool.Args>

open override val description: String

open val descriptor: ToolDescriptor

open override val name: String

resultSerializer

open override val resultSerializer: KSerializer<WriteFileTool.Result>

Functions

fun decodeArgs(rawArgs: JsonObject): WriteFileTool.Args

fun encodeArgs(args: WriteFileTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: WriteFileTool.Args): String

encodeResultToString

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

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

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

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