agents-tools/ai.koog.agents.core.tools.reflect/ToolFromCallable

ToolFromCallable

class ToolFromCallable<TResult>(val callable: KCallable<TResult>, val thisRef: Any? = null, name: String? = null, description: String? = null) : Tool<ToolFromCallable.Args, TResult> (source)

A tool implementation that wraps a Kotlin callable (function, method, etc.).

Parameters

callable

The Kotlin callable (KFunction or KProperty) to be wrapped and executed by this tool.

thisRef

An optional instance reference required if the callable is non-static.

name

The name of the tool. If not provided, the name of the callable will be used.

description

The description of the tool. If not provided, the description from the ai.koog.agents.core.tools.annotations.LLMDescription annotation on the callable will be used.

Constructors

ToolFromCallable

constructor(callable: KCallable<TResult>, thisRef: Any? = null, name: String? = null, description: String? = null)

Types

Args

class Args(val parameters: Map<ERROR CLASS: Symbol not found for KParameter, Any?>)

Arguments for ToolFromCallable.

Properties

argsType

val argsType: ai/koog/serialization/TypeToken

Type token representing arguments type TArgs.

callable

val callable: KCallable<TResult>

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 static metadata associated with the tool. Distinct from the per-call ToolCallMetadata threaded into execute; this field describes the tool, not the invocation.

name

val name: String

The name of the tool from the descriptor.

resultType

val resultType: ai/koog/serialization/TypeToken

Type token representing result type TResult.

thisRef

val thisRef: Any?

Functions

decodeArgs

open fun decodeArgs(rawArgs: ai/koog/serialization/JSONObject, serializer: ai/koog/serialization/JSONSerializer): ToolFromCallable.Args

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

open override fun decodeArgs(rawArgs: ERROR CLASS: Symbol not found for JSONObject, serializer: ERROR CLASS: Symbol not found for JSONSerializer): ToolFromCallable.Args

decodeResult

open fun decodeResult(rawResult: ai/koog/serialization/JSONElement, serializer: ai/koog/serialization/JSONSerializer): TResult

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

open override fun decodeResult(rawResult: ERROR CLASS: Symbol not found for JSONElement, serializer: ERROR CLASS: Symbol not found for JSONSerializer): TResult

encodeArgs

open fun encodeArgs(args: ToolFromCallable.Args, serializer: ai/koog/serialization/JSONSerializer): ai/koog/serialization/JSONObject

Encodes the given arguments into a JSON representation.

open override fun encodeArgs(args: ToolFromCallable.Args, serializer: ERROR CLASS: Symbol not found for JSONSerializer): ERROR CLASS: Symbol not found for JSONObject

encodeArgsToString

fun encodeArgsToString(args: ToolFromCallable.Args, serializer: ai/koog/serialization/JSONSerializer): String

Encodes the provided arguments into a JSON string representation.

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?, serializer: ai/koog/serialization/JSONSerializer): String

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

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?, serializer: ai/koog/serialization/JSONSerializer): ai/koog/serialization/JSONObject

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

encodeResult

open fun encodeResult(result: TResult, serializer: ai/koog/serialization/JSONSerializer): ai/koog/serialization/JSONElement

Encodes the given result into a JSON representation.

open override fun encodeResult(result: TResult, serializer: ERROR CLASS: Symbol not found for JSONSerializer): ERROR CLASS: Symbol not found for JSONElement

encodeResultToString

open fun encodeResultToString(result: TResult, serializer: ai/koog/serialization/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: ai/koog/serialization/JSONSerializer): String

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

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?, serializer: ai/koog/serialization/JSONSerializer): ai/koog/serialization/JSONElement

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

execute

suspend override fun execute(args: ToolFromCallable.Args, metadata: ToolCallMetadata): TResult

Executes the tool's logic with the provided arguments and per-call metadata.

open suspend override fun execute(args: ToolFromCallable.Args): 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.

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

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