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

Tool

abstract class Tool<TArgs, TResult>(val argsType: TypeToken, val resultType: TypeToken, val descriptor: ToolDescriptor, val metadata: Map<String, String> = emptyMap())(source)

Base class representing a tool that can be invoked by the LLM. Tools are usually used to return results, make changes to the environment, or perform other actions.

Parameters

TArgs

The type of arguments the tool accepts.

TResult

The type of result the tool returns.

Inheritors

SimpleTool

ToolFromCallable

Constructors

Tool

constructor(argsType: TypeToken, resultType: TypeToken, descriptor: ToolDescriptor, metadata: Map<String, String> = emptyMap())

constructor(argsType: TypeToken, resultType: TypeToken, name: String, description: String, jsonSchemaConfig: JsonSchemaConfig = defaultJsonSchemaConfig)

Convenience constructor for the base tool class that generates ToolDescriptor from the provided name, description and argsType.

constructor(argsSerializer: KSerializer<TArgs>, resultSerializer: KSerializer<TResult>, descriptor: ToolDescriptor)

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

Types

Args

interface ~~Args~~ : ToolArgs

Base type, representing tool arguments.

EmptyArgs

@Serializable

data object ~~EmptyArgs~~ : Tool.Args

Args implementation that can be used for tools that expect no arguments.

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): TResult

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: TResult, serializer: JSONSerializer): JSONElement

Encodes the given result into a JSON representation.

encodeResultToString

open fun encodeResultToString(result: TResult, 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): TResult

Executes the tool's logic with the provided arguments.

executeUnsafe

suspend fun executeUnsafe(args: Any?): TResult

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