Package org.springframework.ai.tool.toolsearch

Class ToolSearchTool

java.lang.Object

org.springframework.ai.tool.toolsearch.ToolSearchTool

public class ToolSearchTool
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOOL_SEARCH_TOOL_SESSION_ID_KEY

Constructor Summary

Constructors

Constructor	Description
ToolSearchTool(ToolIndex toolIndex, @Nullable Integer advisorMaxResults)

Method Summary

Modifier and Type	Method	Description
List<String>	toolSearchTool(String query, Integer maxResults, String categoryFilter, ToolContext toolContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TOOL_SEARCH_TOOL_SESSION_ID_KEY

public static final String TOOL_SEARCH_TOOL_SESSION_ID_KEY

See Also:

• Constant Field Values

Constructor Details

ToolSearchTool

public ToolSearchTool(ToolIndex toolIndex,
 @Nullable Integer advisorMaxResults)

Method Details

toolSearchTool

@Tool(name="toolSearchTool",
      description="Search for tools in the tool registry to discover capabilities for completing the current task.\nUse this when you need functionality not provided by your currently available tools.\nThe search queries against tool names, descriptions, and parameter information to find the most relevant tools.\nReturns references to matching tools which will be expanded into full definitions you can then invoke.\n")
public List<String> toolSearchTool(@ToolParam(description="A natural language search query describing the tool capability you need. Be specific and include relevant keywords.")
 String query,
 @ToolParam(description="Maximum number of tool references to return (1-10). Default is 5.",required=false)
 Integer maxResults,
 @ToolParam(description="Optional filter to narrow search to a specific tool category.",required=false)
 String categoryFilter,
 ToolContext toolContext)