Embabel Agent Documentation/com.embabel.agent.tools.agent/GoalTool

GoalTool

data class GoalTool<I : Any>(val autonomy: Autonomy, val textCommunicator: TextCommunicator, val name: String, val description: String = goal.description, val goal: Goal, val inputType: Class<I>, val listeners: List<AgenticEventListener> = emptyList()) : Tool

Framework-agnostic Tool implementation for a specific goal.

Constructors

constructor(autonomy: Autonomy, textCommunicator: TextCommunicator, name: String, description: String = goal.description, goal: Goal, inputType: Class<I>, listeners: List<AgenticEventListener> = emptyList())

Properties

val autonomy: Autonomy

open override val definition: Tool.Definition

Tool definition for LLM

val description: String

val inputType: Class<I>

val listeners: List<AgenticEventListener>

open override val metadata: Tool.Metadata

Optional metadata

val name: String

textCommunicator

val textCommunicator: TextCommunicator

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.

open override fun toString(): String

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.

fun withListener(listener: AgenticEventListener): GoalTool<I>

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.