Embabel Agent Documentation/com.embabel.agent.api.tool.agentic.simple/SimpleAgenticTool

SimpleAgenticTool

data class SimpleAgenticTool(val definition: Tool.Definition, val metadata: Tool.Metadata = Tool.Metadata.DEFAULT, val llm: <Error class: unknown class> = LlmOptions(), val tools: List<Tool> = emptyList(), domainToolSources: List<DomainToolSource<*>> = emptyList(), autoDiscovery: Boolean = false, val systemPromptCreator: AgenticSystemPromptCreator = AgenticSystemPromptCreator { _, _ -> AgenticTool.defaultSystemPrompt(definition.description) }, val maxIterations: Int = AgenticTool.DEFAULT_MAX_ITERATIONS, val captureNestedArtifacts: Boolean = false) : AgenticTool<SimpleAgenticTool>

A simple agentic tool where all sub-tools are available immediately.

This is the most basic form of AgenticTool - all tools are available to the LLM from the start with no conditions or state requirements.

For more controlled tool availability, see:

com.embabel.agent.api.tool.agentic.playbook.PlaybookTool: Progressive unlock via conditions
com.embabel.agent.api.tool.agentic.state.StateMachineTool: State-based availability

Parameters

definition

Tool definition (name, description, input schema)

metadata

Optional tool metadata

llm

LLM to use for orchestration

tools

Sub-tools available for the LLM to orchestrate

systemPromptCreator

Create prompt for the LLM to use, given context and input

maxIterations

Maximum number of tool loop iterations

captureNestedArtifacts

Whether to capture artifacts from nested AgenticTools

Constructors

SimpleAgenticTool

constructor(name: String, description: String)

Create a simple agentic tool with name and description.

constructor(definition: Tool.Definition, metadata: Tool.Metadata = Tool.Metadata.DEFAULT, llm: <Error class: unknown class> = LlmOptions(), tools: List<Tool> = emptyList(), domainToolSources: List<DomainToolSource<*>> = emptyList(), autoDiscovery: Boolean = false, systemPromptCreator: AgenticSystemPromptCreator = AgenticSystemPromptCreator { _, _ -> AgenticTool.defaultSystemPrompt(definition.description) }, maxIterations: Int = AgenticTool.DEFAULT_MAX_ITERATIONS, captureNestedArtifacts: Boolean = false)

Properties

captureNestedArtifacts

val captureNestedArtifacts: Boolean = false

open override val definition: Tool.Definition

open override val llm: <Error class: unknown class>

open override val maxIterations: Int

open override val metadata: Tool.Metadata

systemPromptCreator

val systemPromptCreator: AgenticSystemPromptCreator

val tools: List<Tool>

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.

withCaptureNestedArtifacts

fun withCaptureNestedArtifacts(capture: Boolean): SimpleAgenticTool

Create a copy with different captureNestedArtifacts setting.

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 override fun withLlm(llm: <Error class: unknown class>): SimpleAgenticTool

Create a copy with different LLM options.

withMaxIterations

open override fun withMaxIterations(maxIterations: Int): SimpleAgenticTool

Create a copy with a different max iterations limit.

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.

open override fun withParameter(parameter: Tool.Parameter): SimpleAgenticTool

Create a copy with an additional parameter in the definition.

withSystemPrompt

open fun withSystemPrompt(prompt: String): SimpleAgenticTool

Create a copy with a fixed system prompt. This is a convenience method that delegates to withSystemPrompt with a creator.

open override fun withSystemPrompt(creator: AgenticSystemPromptCreator): SimpleAgenticTool

Create a copy with a dynamic system prompt creator. The creator receives the execution context and input string.

withToolChainingFrom

open fun <T : Any> withToolChainingFrom(type: Class<T>): SimpleAgenticTool

Register a class whose @LlmTool methods become available as tools when a single instance of that type is returned as an artifact.

inline fun <T : Any> withToolChainingFrom(): SimpleAgenticTool

Register a class that can contribute @LlmTool methods when a single instance is retrieved. Kotlin-friendly version using reified type parameter.

inline fun <T : Any> withToolChainingFrom(noinline predicate: (T, AgentProcess?) -> Boolean): SimpleAgenticTool

Register a domain class with a predicate. Kotlin-friendly version using reified type parameter.

open override fun <T : Any> withToolChainingFrom(type: Class<T>, predicate: DomainToolPredicate<T>): SimpleAgenticTool

Register a domain class with a predicate to control when its @LlmTool methods become available as tools.

withToolChainingFromAny

open override fun withToolChainingFromAny(): SimpleAgenticTool

Enable auto-discovery of chained tools from any returned artifact.

open override fun withToolObject(toolObject: Any): SimpleAgenticTool

Create a copy with tools extracted from an object with @LlmTool methods. If the object has no @LlmTool methods, returns this unchanged.

withToolObjects

fun withToolObjects(vararg toolObjects: Any): SimpleAgenticTool

Create a copy with tools extracted from multiple objects with @LlmTool methods.

fun withTools(vararg additionalTools: Tool): SimpleAgenticTool

Create a copy with additional tools.