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

ToolRegistry

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

ToolRegistry serves as a central repository for all tools available to an agent. It provides functionality to register tools and retrieve them by name or type.

Key features:

Maintains a unique collection of named tools
Provides methods to retrieve tools by name or type
Supports merging multiple registries

Usage examples:

Creating a registry:

 val registry = ToolRegistry {
     tool(MyCustomTool())
     tool(AnotherTool())
 }

Merging registries:

 val combinedRegistry = registry1 + registry2

Types

Builder

class Builder

Companion

object Companion

Companion object providing factory methods and constants for ToolRegistry.

Properties

tools

val tools: List<Tool<*, *>>

The list of tools contained in this registry

Functions

add

fun add(tool: Tool<*, *>)

addAll

fun addAll(vararg tools: Tool<*, *>)

getTool

inline fun <T : Tool<*, *>> getTool(): T

Retrieves a tool by its type from registry.

fun getTool(toolName: String): Tool<*, *>

Retrieves a tool by its name from the registry.

plus

operator fun plus(toolRegistry: ToolRegistry): ToolRegistry