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

TypedTool

open class TypedTool<I : Any, O : Any>(name: String, description: String, inputType: Class<I>, outputType: Class<O>, val metadata: Tool.Metadata = Tool.Metadata.DEFAULT, objectMapper: <Error class: unknown class> = jacksonObjectMapper(), function: Function<I, O>) : Tool

Tool with strongly typed input and output. Handles JSON marshaling automatically, allowing you to work with domain objects directly.

Example usage:

data class AddRequest(val a: Int, val b: Int)
data class AddResult(val sum: Int)

val addTool = TypedTool(
    name = "add",
    description = "Add two numbers",
    inputType = AddRequest::class.java,
    outputType = AddResult::class.java,
) { input -> AddResult(input.a + input.b) }

Parameters

Input type - will be deserialized from JSON

Output type - will be serialized to JSON (unless it's already a Tool.Result)

name

Tool name for LLM consumption

description

Tool description for LLM consumption

inputType

Class of the input type for JSON deserialization

outputType

Class of the output type (used for documentation)

metadata

Optional tool metadata

objectMapper

ObjectMapper for JSON serialization/deserialization

function

Function that processes typed input and returns typed output

Inheritors

AwaitableTypedTool

SimpleAwaitableTypedTool

Constructors

TypedTool

constructor(name: String, description: String, inputType: Class<I>, outputType: Class<O>, metadata: Tool.Metadata = Tool.Metadata.DEFAULT, objectMapper: <Error class: unknown class> = jacksonObjectMapper(), function: Function<I, O>)

Properties

definition

open override val definition: Tool.Definition

Tool definition for LLM

metadata

open override val metadata: Tool.Metadata

Functions

call

open override fun call(input: String): Tool.Result

Executes the tool by deserializing input JSON, calling typedCall, and serializing the result.

requireType

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.

typedCall

open fun typedCall(input: I): O

Execute the tool with strongly typed input. Calls the function provided at construction time. Can be overridden in subclasses for custom behavior.

unwrapAs

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

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

withAwaiting

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.

withName

open fun withName(newName: String): Tool

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

withNote

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.