Constructor Detail

• StateMachineTool

  StateMachineTool(String name, String description, Class<S> stateType)

  Create a state machine tool with name, description and state enum type.

Method Detail

• getStateToolCounts

   final Map<S, Integer> getStateToolCounts()

• getTotalStateTools

   final Integer getTotalStateTools()

• getDefinition

   Tool.Definition getDefinition()

• getMetadata

   Tool.Metadata getMetadata()

  Optional metadata

• getStateType

   final Class<S> getStateType()

• getInitialState

   final S getInitialState()

• getLlm

   LlmOptions getLlm()

• getSystemPromptCreator

   final Function3<ExecutingOperationContext, String, S, String> getSystemPromptCreator()

• getMaxIterations

   Integer getMaxIterations()

• call

   Tool.Result call(String input)

  Execute the tool with JSON input.

  Parameters:

  input - JSON string matching inputSchema

  Returns:

  Result to send back to LLM

• withInitialState

   final StateMachineTool<S> withInitialState(S state)

  Set the initial state.

• startingIn

   Tool startingIn(S state)

  Create a version of this tool that starts in the specified state. Useful when the starting state depends on runtime context.

• inState

   final StateBuilder<S> inState(S state)

  Begin configuring tools for a specific state.

• withGlobalTool

   final StateMachineTool<S> withGlobalTool(Tool tool)

  Add a tool available in all states.

• withGlobalTools

   final StateMachineTool<S> withGlobalTools(Tool tools)

  Add tools available in all states.

• withLlm

   StateMachineTool<S> withLlm(LlmOptions llm)

  Create a copy with different LLM options.

• withMaxIterations

   StateMachineTool<S> withMaxIterations(Integer maxIterations)

  Create a copy with a different max iterations limit.

• withSystemPrompt

   StateMachineTool<S> withSystemPrompt(AgenticSystemPromptCreator creator)

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

• withStateAwareSystemPrompt

   final StateMachineTool<S> withStateAwareSystemPrompt(Function3<ExecutingOperationContext, String, S, String> creator)

  Set a custom system prompt creator that also receives the current state. This is useful for state machines where the prompt needs to reflect the current state.

• withParameter

   StateMachineTool<S> withParameter(Tool.Parameter parameter)

  Create a copy with an additional parameter in the definition.

• withToolObject

   StateMachineTool<S> withToolObject(Object toolObject)

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

• withToolChainingFrom

   <T extends Any> StateMachineTool<S> withToolChainingFrom(Class<T> type, DomainToolPredicate<T> predicate)

  Register a domain class with a predicate to control when its @LlmTool methods are exposed.

  When a single artifact of the specified type is returned by any tool and passes the predicate, any @LlmTool annotated methods on that instance become available as tools (globally, not state-bound).

  Parameters:

  type - The domain class that may contribute tools

  predicate - Predicate to filter which instances contribute tools

• withToolChainingFrom

   final <T extends Any> StateMachineTool<S> withToolChainingFrom(Function2<T, AgentProcess, Boolean> predicate)

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

• withToolChainingFrom

   final <T extends Any> StateMachineTool<S> withToolChainingFrom()

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

  Example:

  StateMachineTool("orderProcessor", "Process orders", OrderState::class.java)
      .withToolChainingFrom<Order>()  // Order methods become available when a single Order is retrieved
      .withInitialState(OrderState.DRAFT)
      ...

• withToolChainingFromAny

   StateMachineTool<S> withToolChainingFromAny()

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

  When enabled, any artifact with @LlmTool methods will automatically have its tools exposed, replacing ALL previous bindings.