Embabel Agent Documentation/com.embabel.agent.core.hitl/ConfirmingTool

ConfirmingTool

class ConfirmingTool(val delegate: Tool, messageProvider: (String) -> String) : DelegatingTool

Tool decorator that always requires confirmation before executing the delegate.

When called, this tool throws AwaitableResponseException with a ConfirmationRequest. The framework handles the pause, the UX presents the confirmation, and if accepted, the tool is re-invoked (this time the confirmation is already satisfied via blackboard state).

Parameters

delegate

The tool to wrap

messageProvider

Function to generate the confirmation message from input

Constructors

constructor(delegate: Tool, messageProvider: (String) -> String)

Properties

open override val definition: Tool.Definition

Tool definition for LLM

open override val delegate: Tool

open override val metadata: Tool.Metadata

Optional metadata

Functions

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.

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.