Package io.openliberty.mcp.tools

Interface ToolManager

All Superinterfaces:

FeatureManager<ToolManager.ToolInfo>, Iterable<ToolManager.ToolInfo>

public interface ToolManager
extends FeatureManager<ToolManager.ToolInfo>

Allows registering new tools, removing tools and getting information about registered tools.

An instance can be obtained by injecting with @Inject.

In an enterprise application, each web module has its own ToolManager. Calling methods on the ToolManager will affect the current web module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ToolManager.ToolAnnotations	The MCP annotations of a tool.
static interface	ToolManager.ToolArgument	Information about a tool argument
static interface	ToolManager.ToolArguments	The input to a tool handler, providing access to the arguments.
static interface	ToolManager.ToolDefinition	A builder to define a new tool.
static interface	ToolManager.ToolInfo	Tool info.

Nested classes/interfaces inherited from interface io.openliberty.mcp.features.FeatureManager

FeatureManager.FeatureArguments, FeatureManager.FeatureDefinition<INFO extends FeatureManager.FeatureInfo,ARGUMENTS extends FeatureManager.FeatureArguments,RESPONSE,THIS extends FeatureManager.FeatureDefinition<INFO,ARGUMENTS,RESPONSE,THIS>>, FeatureManager.FeatureInfo, FeatureManager.RequestFeatureArguments

Method Summary

Modifier and Type	Method	Description
ToolManager.ToolInfo	getTool(String name)	Gets information about a tool.
ToolManager.ToolDefinition	newTool(String name)	Adds a tool.
ToolManager.ToolInfo	removeTool(String name)	Removes a tool previously added with newTool(String).

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getTool

ToolManager.ToolInfo getTool(String name)

Gets information about a tool.

Parameters:

name - the name of the tool

Returns:

the tool with the given name, or null

newTool

ToolManager.ToolDefinition newTool(String name)

Adds a tool.

Parameters:

name - the name of the tool. Must be unique.

Returns:

a new tool definition builder

Throws:

IllegalArgumentException - if a tool with the given name already exits

See Also:

• ToolManager.ToolDefinition.register()

removeTool

ToolManager.ToolInfo removeTool(String name)

Removes a tool previously added with newTool(String).

Returns:

the removed tool or null if no such tool existed