Embabel Agent Documentation/com.embabel.agent.spi.support/ExceptionSuppressingTool

ExceptionSuppressingTool

class ExceptionSuppressingTool(val delegate: Tool) : DelegatingTool

Tool decorator that suppresses exceptions and returns a warning message instead.

Note: ToolControlFlowSignal exceptions are NOT suppressed - they are control flow signals that must propagate (e.g., ReplanRequestedException, UserInputRequiredException).

Constructors

constructor(delegate: Tool)

Properties

definition

open override val definition: Tool.Definition

Tool definition for LLM

delegate

open override val delegate: Tool

The underlying tool being delegated to.

metadata

open override val metadata: Tool.Metadata

Optional metadata

Functions

call

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

Routes single-arg calls through the canonical two-arg method, ensuring decorator logic in call (String, ToolCallContext) is always executed regardless of which overload the caller uses.

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

Canonical entry point for decorator logic. Override this method to add behavior while preserving context propagation to delegate.

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.

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.