mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-22 13:34:17 +02:00
28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
# ToolSearch plugin
|
|
|
|
When a server exposes many tools, listing them all at once can overwhelm an LLM's context window. The `ToolSearch` plugin collapses the full tool catalog behind a search interface — clients see only `search_tools` and `call_tool`, and discover the real tools on demand.
|
|
|
|
## Two search strategies
|
|
|
|
**Regex** (`strategy="regex"`) — clients search with regex patterns like `add|multiply` or `text.*`. Fast and precise when you know what you're looking for.
|
|
|
|
**BM25** (`strategy="bm25"`) — clients search with natural language like `"work with numbers"`. Results are ranked by relevance using BM25 scoring. The index rebuilds automatically when tools change.
|
|
|
|
Both strategies respect the full auth pipeline: middleware, visibility transforms, and component-level auth checks all apply to search results.
|
|
|
|
```python
|
|
from fastmcp import FastMCP
|
|
from fastmcp.server.plugins.tool_search import ToolSearch, ToolSearchConfig
|
|
|
|
mcp = FastMCP("Server", plugins=[ToolSearch(ToolSearchConfig(strategy="regex"))])
|
|
```
|
|
|
|
## Run
|
|
|
|
```bash
|
|
# Regex
|
|
uv run python examples/tool_search/client_regex.py
|
|
|
|
# BM25
|
|
uv run python examples/tool_search/client_bm25.py
|
|
```
|