Embabel Agent Documentation/com.embabel.agent.tools.agent/AgentTool

AgentTool

data class AgentTool<I : Any>(autonomy: Autonomy, val agent: Agent, val textCommunicator: TextCommunicator, val objectMapper: <Error class: unknown class>, val inputType: Class<I>, val processOptionsCreator: (parentAgentProcess: AgentProcess) -> ProcessOptions) : Tool

Tool that can be used to execute an agent. Supports "Subagent" or "handoff" style usage.

This is the framework-agnostic version that implements Embabel's Tool interface.

Constructors

constructor(autonomy: Autonomy, agent: Agent, textCommunicator: TextCommunicator, objectMapper: <Error class: unknown class>, inputType: Class<I>, processOptionsCreator: (parentAgentProcess: AgentProcess) -> ProcessOptions)

Properties

val agent: Agent

open override val definition: Tool.Definition

Tool definition for LLM

val inputType: Class<I>

open override val metadata: Tool.Metadata

Optional metadata

val objectMapper: <Error class: unknown class>

processOptionsCreator

val processOptionsCreator: (parentAgentProcess: AgentProcess) -> ProcessOptions

textCommunicator

val textCommunicator: TextCommunicator

Functions

open fun call(input: String, context: ToolCallContext): Tool.Result

Execute the tool with JSON input and out-of-band context.

open override 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.

open override fun toString(): String

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.

withDefinitionMetadata

open fun withDefinitionMetadata(entries: Map<String, Any>): Tool

Create a new tool with additional definition metadata entries merged in. Existing keys are overwritten by the new values.

open fun withDefinitionMetadata(key: String, value: Any): Tool

Create a new tool with a single definition metadata entry added.

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.