Search Knowledge Base
Tool ID: kb_search
Summary
Full-text search across published knowledge base pages. Returns matching paths with titles and short summaries — not the full page body.
You can ask in natural language or pass keywords. Filler words (English and German) and very short tokens are ignored; remaining terms are matched with a soft OR so one slightly off word does not wipe the results. Scores are ranked 0–1 for that query.
When to use it
- Find the right page quickly — When you know the topic but not the path.
- Gather candidates before reading — Review summaries, then open one page with Get.
- Answer from official docs — Prefer these hits over guessing.
What you need
| Requirement | Required? |
|---|---|
| Metraclick connection | Yes |
| Tool enabled for your account | Yes |
| Extra service credentials | No |
Parameters
| Parameter | Required? | Description |
|---|---|---|
query |
Yes | Natural-language question or keywords. Advanced MySQL BOOLEAN expressions are also accepted. |
limit |
No | Maximum results (1–20). Default: 10. |
What you get back
| Field | Meaning |
|---|---|
row_count |
How many pages matched (after dropping zero scores) |
rows |
Each hit: path, title, summary, score (0–1 for this query) |
The full Markdown is not included. Call Get with a path to load it.
{
"tool": "kb_search",
"query": "how do I write a knowledge base page",
"row_count": 1,
"rows": [
{
"path": "guides/knowledge-base",
"title": "Knowledge Base guide",
"summary": "How to write and publish knowledge base pages.",
"score": 1
}
]
}
Example prompts
How do I send a message on Telegram?
Can I read the transcript of a video?
Search the knowledge base for: connect client.
Find knowledge base pages about billing invoices.
Look up refund policy in the shared knowledge base and summarize the matching pages.
Tips
- Natural-language questions work; you do not need to strip filler words yourself.
- Rows with no real match (score 0) are never returned.
- After you pick a hit, ask the AI to get that path for the full content.