Embabel Agent Documentation/com.embabel.agent.api.tool/Tool

Tool

interface Tool : ToolInfo

Framework-agnostic tool that can be invoked by an LLM. Adapters in SPI layer bridge to Spring AI ToolCallback or LangChain4j ToolSpecification/ToolExecutor.

All nested types are scoped within this interface to avoid naming conflicts with framework-specific types (e.g., Spring AI's ToolDefinition, ToolMetadata).

Inheritors

ProgressiveTool

SpringToolCallbackWrapper

McpAwareGoalTool

McpAwareGoalTool

Types

object Companion : TypedToolFactory, MethodToolFactory, ReplanningToolFactory, ArtifactSinkFactory

interface Definition

Framework-agnostic tool definition.

fun interface Function

Functional interface for simple tool implementations.

@FunctionalInterface

fun interface Handler

Java-friendly functional interface for tool implementations. Uses handle method name which is more idiomatic in Java than invoke.

interface InputSchema

Input schema for a tool, supporting both simple and complex parameters.

interface Metadata

Optional metadata about a tool's behavior.

data class Parameter constructor(val name: String, val type: Tool.ParameterType, val description: String = name, val required: Boolean = true, val enumValues: List<String>? = null, val properties: List<Tool.Parameter>? = null, val itemType: Tool.ParameterType? = null)

A single parameter for a tool.

enum ParameterType : Enum<Tool.ParameterType>

Supported parameter types.

sealed interface Result

Result of tool execution with optional artifacts.

Properties

abstract val definition: Tool.Definition

Tool definition for LLM

open val metadata: Tool.Metadata

Optional metadata

Functions

abstract fun call(input: String): Tool.Result

Execute the tool with JSON input.

inline fun <T : Any> Tool.requireType(message: String? = null): Tool

Wrap this tool to require a value of type T before execution (reified).

fun <T : Any> Tool.requireType(type: Class<T>, messageProvider: (String) -> String? = { null }): Tool

Wrap this tool to require a value of type T before execution.

toSpringToolCallback

fun Tool.toSpringToolCallback(): <Error class: unknown class>

Extension function to convert an Embabel Tool to a Spring AI ToolCallback.

inline fun <T : Tool> Tool.unwrapAs(): T?

Unwrap a tool to find a specific type, or return null if not found.

fun Tool.withAwaiting(decider: AwaitDecider): Tool

Wrap this tool to conditionally await before execution.

withConfirmation

fun Tool.withConfirmation(messageProvider: (String) -> String): Tool

fun Tool.withConfirmation(message: String): Tool

Wrap this tool to always require confirmation before execution.

withDescription

open fun withDescription(newDescription: String): Tool

Create a new tool with a different description. Useful for providing context-specific descriptions while keeping the same functionality.

withEventPublication

fun Tool.withEventPublication(agentProcess: AgentProcess, action: Action?, llmOptions: <Error class: unknown class>): Tool

Extension function to wrap a Tool with event publication.

open fun withName(newName: String): Tool

Create a new tool with a different name. Useful for namespacing tools when combining multiple tool sources.

open fun withNote(note: String): Tool

Create a new tool with an additional note appended to the description. Useful for adding context-specific hints to an existing tool.