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

ReplanningTool

class ReplanningTool constructor(val delegate: Tool, reason: String, blackboardUpdater: ReplanningToolBlackboardUpdater = ReplanningToolBlackboardUpdater { bb, content -> bb.addObject( content ) }) : DelegatingTool

Tool decorator that executes the wrapped tool, adds its result to the blackboard, then throws ReplanRequestedException to terminate the tool loop and trigger replanning.

This enables patterns like:

Chat routing: A routing tool classifies intent and triggers replan to switch handlers
Discovery: A tool discovers information that requires a different plan

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

Parameters

delegate

The tool to wrap

reason

Human-readable explanation of why replan is needed

blackboardUpdater

Callback to update the blackboard before replanning. Receives the result content and can add objects to the blackboard. Defaults to adding the result content as a string.

Constructors

constructor(delegate: Tool, reason: String, blackboardUpdater: ReplanningToolBlackboardUpdater = ReplanningToolBlackboardUpdater { bb, content -> bb.addObject( content ) })

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.