ai-elements-koog/dev.ai.elements.koog/KoogTool

KoogTool

class KoogTool(val tool: AgentTool, run: suspend (JsonObject) -> String = tool::execute) : Tool<JsonObject, String> (source)

An AI Elements AgentTool as a Koog tool: JSON arguments in, text out. run defaults to the tool itself; KoogBackend routes it through the chat's tool events (approval, progress) instead.

Constructors

KoogTool

constructor(tool: AgentTool, run: suspend (JsonObject) -> String = tool::execute)

Properties

argsType

val argsType: TypeToken

descriptor

val descriptor: ToolDescriptor

metadata

val metadata: Map<String, String>

name

val name: String

resultType

val resultType: TypeToken

tool

val tool: AgentTool

Functions

decodeArgs

open override fun decodeArgs(rawArgs: JSONObject, serializer: JSONSerializer): JsonObject

decodeResult

open override fun decodeResult(rawResult: JSONElement, serializer: JSONSerializer): String

encodeArgs

open fun encodeArgs(args: JsonObject, serializer: JSONSerializer): JSONObject

encodeArgsToString

fun encodeArgsToString(args: JsonObject, serializer: JSONSerializer): String

encodeArgsToStringUnsafe

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

encodeArgsUnsafe

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

encodeResult

open override fun encodeResult(result: String, serializer: JSONSerializer): JSONElement

encodeResultToParts

open fun encodeResultToParts(result: String, serializer: JSONSerializer): List<MessagePart.ContentPart>

encodeResultToPartsUnsafe

fun encodeResultToPartsUnsafe(result: Any?, serializer: JSONSerializer): List<MessagePart.ContentPart>

encodeResultToString

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

The model sees the tool's text as is, not as a JSON string literal.

encodeResultToStringUnsafe

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

encodeResultUnsafe

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

execute

suspend override fun execute(args: JsonObject, metadata: ToolCallMetadata): String

open suspend override fun execute(args: JsonObject): String

executeUnsafe

suspend fun executeUnsafe(args: Any?): String

suspend fun executeUnsafe(args: Any?, metadata: ToolCallMetadata): String