Embabel Agent Documentation/com.embabel.agent.api.tool/Tool/Companion

Companion

object Companion : TypedToolFactory, MethodToolFactory, ReplanningToolFactory, ArtifactSinkFactory

Functions

open override fun <T> conditionalReplan(tool: Tool, decider: (t: T, replanContext: ReplanContext) -> ReplanDecision?): DelegatingTool

When the decider returns a ReplanDecision, replan after execution, adding the artifact to the blackboard along with any additional updates from the decision. The decider receives the artifact cast to type T and the replan context. If the artifact is null or cannot be cast to T, the decider is not called.

create

fun create(name: String, description: String, handler: Tool.Handler): Tool

Create a tool with no parameters (Java-friendly). This method is easier to call from Java as it uses the Handler interface.

fun create(name: String, description: String, inputSchema: Tool.InputSchema, handler: Tool.Handler): Tool

Create a tool with input schema (Java-friendly).

fun create(name: String, description: String, metadata: Tool.Metadata, handler: Tool.Handler): Tool

Create a tool with custom metadata (Java-friendly).

fun create(name: String, description: String, inputSchema: Tool.InputSchema, metadata: Tool.Metadata, handler: Tool.Handler): Tool

Create a fully configured tool (Java-friendly).

formatToolTree

fun formatToolTree(name: String, tools: List<Tool>): String

Format a list of tools as an ASCII tree structure. UnfoldingTools are expanded recursively to show their inner tools.

fromFunction

open override fun fromFunction(name: String, description: String, inputType: Class, outputType: Class<O>, function: Function<I, O>): Tool

Create a tool with strongly typed input and output (Java-friendly).

open override fun fromFunction(name: String, description: String, inputType: Class, outputType: Class<O>, metadata: Tool.Metadata, function: Function<I, O>): Tool

Create a tool with strongly typed input and output with custom metadata (Java-friendly).

open override fun fromFunction(name: String, description: String, inputType: Class, outputType: Class<O>, metadata: Tool.Metadata, objectMapper: <Error class: unknown class>, function: Function<I, O>): Tool

Create a tool with strongly typed input and output with custom ObjectMapper (Java-friendly).

fromFunction

inline fun TypedToolFactory.fromFunction(name: String, description: String, metadata: Tool.Metadata = Tool.Metadata.DEFAULT, objectMapper: <Error class: unknown class> = jacksonObjectMapper(), noinline function: (I) -> O): Tool

Kotlin-friendly extension for creating typed tools with reified type parameters.

fromInstance

fun fromInstance(instance: Any): List<Tool>

open override fun fromInstance(instance: Any, objectMapper: <Error class: unknown class>): List<Tool>

Create Tools from all methods annotated with LlmTool on an instance.

fromMethod

open fun fromMethod(instance: Any, method: Method, objectMapper: <Error class: unknown class> = jacksonObjectMapper()): Tool

Create a Tool from a Java method annotated with LlmTool.

open fun fromMethod(instance: Any, method: KFunction<*>, objectMapper: <Error class: unknown class> = jacksonObjectMapper()): Tool

Create a Tool from a Kotlin method annotated with LlmTool.

fun of(name: String, description: String, metadata: Tool.Metadata = Metadata.DEFAULT, function: Tool.Function): Tool

Create a tool with no parameters.

fun of(name: String, description: String, inputSchema: Tool.InputSchema, metadata: Tool.Metadata = Metadata.DEFAULT, function: Tool.Function): Tool

Create a tool from a function.

publishToBlackboard

open override fun publishToBlackboard(tool: Tool): Tool

Wrap a tool to publish all artifacts to the blackboard.

open override fun <T : Any> publishToBlackboard(tool: Tool, clazz: Class<T>): Tool

Wrap a tool to publish artifacts of the specified type to the blackboard.

open override fun <T : Any> publishToBlackboard(tool: Tool, clazz: Class<T>, filter: (T) -> Boolean, transform: (T) -> Any): Tool

Wrap a tool to publish artifacts of the specified type to the blackboard, with optional filtering and transformation.

replanAlways

open override fun replanAlways(tool: Tool): Tool

Make this tool always replan after execution, adding the artifact to the blackboard.

replanAndAdd

open override fun <T> replanAndAdd(tool: Tool, valueComputer: (t: T) -> Any?): DelegatingTool

Replan and add the object returned by the valueComputer to the blackboard.

replanWhen

open override fun <T> replanWhen(tool: Tool, predicate: (t: T) -> Boolean): DelegatingTool

When the predicate matches the tool result artifact, replan, adding the artifact to the blackboard. The predicate receives the artifact cast to type T. If the artifact is null or cannot be cast to T, returns normally.

safelyFromInstance

fun safelyFromInstance(instance: Any): List<Tool>

open override fun safelyFromInstance(instance: Any, objectMapper: <Error class: unknown class>): List<Tool>

Safely create Tools from an instance, returning empty list if no annotated methods found. This is useful when you want to scan an object that may or may not have tool methods.

sinkArtifacts

open override fun <T : Any> sinkArtifacts(tool: Tool, clazz: Class<T>, sink: ArtifactSink): Tool

Wrap a tool to sink artifacts of the specified type to the given sink. Handles both single artifacts and Iterables.

open override fun <T : Any> sinkArtifacts(tool: Tool, clazz: Class<T>, sink: ArtifactSink, filter: (T) -> Boolean, transform: (T) -> Any): Tool

Wrap a tool to sink artifacts of the specified type to the given sink, with optional filtering and transformation.