Skip to main content
Glama

search_docs

Search official open-source AI-infra and Kubernetes documentation by keyword to find version-pinned, citation-ready pointers instead of fetching full pages.

Instructions

Keyword (BM25) search over official docs. Returns compact pointers, not full text.

Args:
    query: English keywords, e.g. 'InferenceService autoscaling' or 'prefix cache aware routing'.
    project: restrict to one project id from list_projects (recommended). Omit to search the latest docs of all projects.
    version: ONLY if the user asked for a specific release; omit it otherwise (= latest).
        Unknown versions fall back to latest with a note.
    limit: max hits (default 5).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYes
projectNo
versionNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden and does disclose non-obvious behavior: results are pointers rather than full text, and unknown versions silently fall back to latest with a note. It omits ordering/ranking behavior, result size characteristics beyond 'compact', and any rate or auth constraints, keeping it just under a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core capability is front-loaded in the first sentence and the args follow in a scannable list with no filler. The only minor redundancy is restating limit's default of 5, which the schema already declares.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return structure needn't be spelled out, yet the description usefully characterizes the return as compact pointers. Combined with full parameter guidance and the version fallback note, nothing an agent needs to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description fully compensates: it gives query examples in the domain's own vocabulary, explains project scoping and the omit-to-search-all semantics, explains that version should normally be omitted and what happens on unknown values, and states limit's role. Every parameter gains meaning not present in the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific retrieval method (keyword BM25 search) over a specific resource (official docs), and immediately contrasts the output with full-text retrieval ('compact pointers, not full text'), which implicitly distinguishes it from read_chunks. An agent can tell what this does without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete conditions for each parameter: project is 'recommended' and omission searches all projects, version is 'ONLY if the user asked for a specific release' and omitted otherwise, and it routes to list_projects for valid ids. It lacks an explicit statement of when to prefer this over read_chunks or whats_new, so it stops short of full when/when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.