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

Package-level declarations

Types

SimpleTool

abstract class SimpleTool<TArgs : Tool.Args> : Tool<TArgs, ToolResult.Text>

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

Tool

abstract class Tool<TArgs : Tool.Args, TResult : ToolResult>

Represents a tool that, when executed, makes changes to the environment.

ToolDescriptor

data 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

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

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.