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

Package-level declarations

Types

abstract class SimpleTool<TArgs>(argsSerializer: KSerializer<TArgs>, name: String, description: String) : Tool<TArgs, String>

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

Tool

abstract class Tool<TArgs, TResult>(val argsSerializer: KSerializer<TArgs>, val resultSerializer: KSerializer<TResult>, val descriptor: ToolDescriptor)

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.

ToolArgs

interface ~~ToolArgs~~

Represents the arguments for a tool operation. Args should be serializable, serializer should be presented in the Tool the arguments belong to.

ToolDescriptor

open class ToolDescriptor(val name: String, val description: String, val requiredParameters: List<ToolParameterDescriptor> = emptyList(), val optionalParameters: List<ToolParameterDescriptor> = emptyList())

Represents a descriptor for a tool that contains information about the tool's name, description, required parameters, and optional parameters.

ToolException

@Serializable

sealed class ToolException : Exception

A base sealed class representing exceptions specific to tools. This class provides a structure for exceptions with a custom message.

ToolParameterDescriptor

data class ToolParameterDescriptor(val name: String, val description: String, val type: ToolParameterType)

Represents a descriptor for a tool parameter. A tool parameter descriptor contains information about a specific tool parameter, such as its name, description, data type, and default value.

ToolParameterType

sealed class ToolParameterType

Sealed class representing different types of tool parameters.

ToolRegistry

class ToolRegistry

A registry that manages a collection of tools for use by agents.

ToolResult

interface ~~ToolResult~~

Represents a result produced by a tool operation. This is a marker interface implemented by various result types.

Functions

asToolDescriptor

fun SerialDescriptor.asToolDescriptor(toolName: String, toolDescription: String? = null, valueDescription: String? = null): ToolDescriptor

Converts a SerialDescriptor into a ToolDescriptor with metadata about a tool, including its name, description, and parameters.

asToolDescriptorSerializer

fun <T> KSerializer<T>.asToolDescriptorSerializer(): KSerializer<T>

Provides a custom serializer for tools, wrapping and unwrapping values that do not serialize into JsonObject into a custom JsonObject with value key. This wrapping/unwrapping is needed because for LLM APIs tool arguments must always be JsonObject.

fail

fun fail(message: String): Nothing

Throws a ToolException.ValidationFailure exception with the specified error message.

validate

fun validate(expectation: Boolean, message: () -> String)

Validates a given condition and throws a ToolException.ValidationFailure exception if the condition is not met.

validateNotNull

fun <T : Any> validateNotNull(value: T?, message: () -> String): T

Validates that the provided value is not null. If the value is null, a ToolException.ValidationFailure exception is thrown with the provided error message.