Package io.micronaut.mcp.server.tools.search

Interface SearchTool

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SearchTool

The search tool is responsible for returning a list of relevant search results from your MCP server's data source, given a user's query. search tool

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DESCRIPTION
static final String	DEFAULT_NAME
static final String	DEFAULT_TITLE

Method Summary

Modifier and Type	Method	Description
default @NonNull String	getDescription()
default @NonNull String	getName()
default @NonNull String	getTitle()
@NonNull SearchResponse	search(@NonNull SearchRequest request, @Nullable io.modelcontextprotocol.common.McpTransportContext mcpTransportContext)

Field Details

DEFAULT_NAME

static final String DEFAULT_NAME

See Also:

• Constant Field Values

DEFAULT_TITLE

static final String DEFAULT_TITLE

See Also:

• Constant Field Values

DEFAULT_DESCRIPTION

static final String DEFAULT_DESCRIPTION

See Also:

• Constant Field Values

Method Details

getName

@NonNull
default @NonNull String getName()

Returns:

MCP Tool Name

getTitle

@NonNull
default @NonNull String getTitle()

Returns:

MCP Tool Title

getDescription

@NonNull
default @NonNull String getDescription()

Returns:

MCP Tool Description

search

@NonNull
@NonNull SearchResponse search(@NonNull
 @NonNull SearchRequest request,
 @Nullable
 @Nullable io.modelcontextprotocol.common.McpTransportContext mcpTransportContext)

Parameters:

request - A single query string.

mcpTransportContext - MCP Transport Context

Returns:

An object with a single key, results, whose value is an array of result objects.