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

ConditionalReplanningTool

class ConditionalReplanningTool(val delegate: Tool, decider: ReplanDecider) : DelegatingTool

Tool decorator that executes the wrapped tool, then conditionally triggers replanning based on the result.

Unlike ReplanningTool which always triggers replanning, this tool allows the ReplanDecider to inspect the result and decide whether to replan.

Note: This tool accesses AgentProcess via thread-local at call time, which is set by the decorator chain.

Parameters

delegate

The tool to wrap

decider

Decider that inspects the result context and determines whether to replan

Constructors

ConditionalReplanningTool

constructor(delegate: Tool, decider: ReplanDecider)

Properties

definition

open override val definition: Tool.Definition

Tool definition for LLM

delegate

open override val delegate: Tool

metadata

open override val metadata: Tool.Metadata

Optional metadata

Functions

call

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

Execute the tool with JSON input.

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.