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.

When to use it

  • Find the right page quickly — When you know keywords 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 Keywords to search for (or an advanced boolean expression).
limit No Maximum results (1–20). Default: 10.

What you get back

Field Meaning
row_count How many pages matched
rows Each hit: path, title, summary, score

The full Markdown is not included. Call Get with a path to load it.

{
  "tool": "kb_search",
  "query": "welcome knowledge",
  "row_count": 1,
  "rows": [
    {
      "path": "welcome",
      "title": "Welcome to the Knowledge Base",
      "summary": "Intro to the shared Metraclick knowledge base for agents.",
      "score": 1.2
    }
  ]
}

Example prompts

Search the knowledge base for how to connect a client.

Find knowledge base pages about billing or invoices.

Look up refund policy in the shared knowledge base and summarize the matching pages.

Tips

  • Prefer short, meaningful keywords over long sentences.
  • Very short words may be ignored by MySQL full-text search.
  • After you pick a hit, ask the AI to get that path for the full content.

Related