agents-tools/ai.koog.agents.core.tools/SimpleTool

SimpleTool

abstract class SimpleTool<TArgs>(argsType: TypeToken, name: String, description: String) : Tool<TArgs, String> (source)

Represents a simplified tool base class that processes specific arguments and produces a textual result.

Parameters

TArgs

The type of arguments the tool accepts.

Constructors

SimpleTool

constructor(argsType: TypeToken, name: String, description: String)

constructor(argsSerializer: KSerializer<TArgs>, name: String, description: String)

Properties

argsType

val argsType: TypeToken

Type token representing arguments type TArgs.

descriptor

val descriptor: ToolDescriptor

A ToolDescriptor representing the tool's schema, including its name, description, and parameters.

metadata

val metadata: Map<String, String>

A map of arbitrary metadata associated with the tool.

name

val name: String

The name of the tool from the descriptor

resultType

val resultType: TypeToken

Type token representing result type TResult.

Functions

decodeArgs

open fun decodeArgs(rawArgs: JSONObject, serializer: JSONSerializer): TArgs

Decodes the provided raw JSON arguments into an instance of the specified arguments type.

decodeResult

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

Decodes the provided raw JSON element into an instance of the specified result type.

encodeArgs

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

Encodes the given arguments into a JSON representation.

encodeArgsToString

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

Encodes the provided arguments into a JSON string representation.

encodeArgsToStringUnsafe

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

Encodes the provided arguments into a JSON string representation without type safety checks.

encodeArgsUnsafe

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

Encodes the given arguments into a JSON representation without type safety checks.

encodeResult

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

Encodes the given result into a JSON representation.

encodeResultToString

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

Encodes the given result of type TResult to its string representation. This is used to provide the LLM with the result of the tool execution. It can be overridden to customize the string representation the LLM will see.

encodeResultToStringUnsafe

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

Encodes the provided result object into a JSON string representation without type safety checks.

encodeResultUnsafe

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

Encodes the given result object into a JSON representation without type safety checks.

execute

abstract suspend fun execute(args: TArgs): String

Executes the tool's logic with the provided arguments.

executeUnsafe

suspend fun executeUnsafe(args: Any?): String

Executes the tool with the provided arguments without type safety checks.