Embabel Agent Documentation/com.embabel.agent.api.common/PromptRunner/withToolGroup

withToolGroup

open fun withToolGroup(toolGroup: String): PromptRunner

Add a tool group to the PromptRunner

Return

PromptRunner instance with the added tool group

Parameters

toolGroup

name of the toolGroup we're requesting

open fun withToolGroup(toolGroup: String, vararg requiredToolNames: String): PromptRunner

Add a tool group with required tool names. Throws com.embabel.agent.spi.loop.RequiredToolGroupException at resolution time if the group is not found or any required tool name is absent.

Parameters

toolGroup

name of the toolGroup we're requesting

requiredToolNames

tool names that must be present in the resolved group

open fun withToolGroup(toolGroup: String, terminationScope: TerminationScope, vararg requiredToolNames: String): PromptRunner

Add a tool group with required tool names and a termination scope. When the group is not found or any required tool name is absent at resolution time, the behavior depends on terminationScope:

Parameters

toolGroup

name of the toolGroup we're requesting

terminationScope

what to terminate when required tools are missing

requiredToolNames

tool names that must be present in the resolved group

abstract fun withToolGroup(toolGroup: ToolGroup): PromptRunner

Allows for dynamic tool groups to be added to the PromptRunner.

abstract fun withToolGroup(toolGroup: ToolGroupRequirement): PromptRunner