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

Package-level declarations

Types

Link copied to clipboard
class ToolFromCallable(callable: KCallable<*>, thisRef: Any? = null, val descriptor: ToolDescriptor, json: Json = Json, val resultSerializer: KSerializer<Any?>) : Tool<ToolFromCallable.VarArgs, Any?>

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

Link copied to clipboard
interface ToolSet

A marker interface for a set of tools that can be converted to a list of ai.koog.agents.core.tools.Tools via reflection using asTools.

Functions

Link copied to clipboard
fun <A> KFunction<A>.asTool(json: Json = Json, thisRef: Any? = null, name: String? = null, description: String? = null): Tool<ToolFromCallable.VarArgs, A>

Converts a KFunction into a code-engine tool that works by reflection.

Link copied to clipboard
fun KFunction<*>.asToolDescriptor(name: String? = null, description: String? = null): ToolDescriptor

Converts a KFunction into a ToolDescriptor that provides detailed metadata about the tool's name, description, and parameter requirements. This can be used to programmatically describe and interact with a tool function.

Link copied to clipboard
fun ToolSet.asTools(json: Json = Json): List<Tool<ToolFromCallable.VarArgs, *>>

Converts all instance methods of this class marked as Tool to a list of tools.

fun <T : ToolSet> KClass<out T>.asTools(json: Json = Json, thisRef: T? = null): List<Tool<ToolFromCallable.VarArgs, *>>

Converts all functions of this class marked as Tool to a list of tools.

Link copied to clipboard
inline fun <T : ToolSet> T.asToolsByInterface(json: Json = Json): List<Tool<ToolFromCallable.VarArgs, *>>

Converts all instance methods of class/interface T marked as Tool to a list of tools that will be called on object this.

Link copied to clipboard
fun KType.asToolType(): ToolParameterType

Converts a Kotlin reflection type (KType) to a corresponding ToolParameterType.

Link copied to clipboard
fun ToolRegistry.Builder.tool(toolFunction: KFunction<*>, json: Json = Json, thisRef: Any? = null, name: String? = null, description: String? = null)

Registers a tool in the ToolRegistry using a given function and optional parameters to customize the tool's properties.

Link copied to clipboard
fun ToolRegistry.Builder.tools(toolSet: ToolSet, json: Json = Json)

Registers a set of tools in the ToolRegistry using a given ToolSet.