Skip to main content
Glama

Search the QRdx docs

search_docs
Read-onlyIdempotent

Find QRdx docs pages for a question or some key words: how a feature works, API endpoints and fields, limits and plans, the React library. Returns up to 8 pages, best first, each with its title, URL, path and a matching snippet. The docs are in English: search with English words. Pass a result's path to read_docs_page for the page itself.

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
queryYesThe question or key words to search for, in English.
languageNoIgnored. The docs are in English only, so results always come back in English. Accepted so that callers written while the docs were translated keep working.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / language / description
      Previous value: -"The docs language: a code such as es, pt-BR, fr, de, it, ja, ko, zh-Hans, id or hi. English without it. A page that isn't translated comes back in English."New value: +"Ignored. The docs are in English only, so results always come back in English. Accepted so that callers written while the docs were translated keep working."
    • changedInput schema / properties / query / description
      Previous value: -"The question or key words to search for."New value: +"The question or key words to search for, in English."
  2. Added

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already declare read-only, idempotent, closed-world behavior, so the safety profile is covered. The description adds behavior the annotations cannot: a hard cap of 8 results, best-first ordering, and the exact fields of each result (title, URL, path, snippet). It also flags that the docs are English-only and that `language` is ignored, which prevents a caller from mistaking it for a locale switch.

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?

Four sentences, front-loaded with purpose, then results, then the language constraint, then the handoff to read_docs_page. Almost every clause earns its place; the English-only point is repeated once more than strictly necessary given the schema already carries it.

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?

With no output schema, the description correctly takes on the burden of describing the return value: count, ordering, and per-result fields. For a simple two-parameter search tool, the added notes on language and the read_docs_page handoff cover everything an agent needs to call it and act on the results.

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

Parameters3/5

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

Schema description coverage is 100%, so both `query` and the ignored `language` parameter are already documented, and the baseline of 3 applies. The description reinforces that queries must be English and explains how the returned `path` feeds into read_docs_page, but it adds no syntax, format, or ranking hints beyond the schema.

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

Purpose4/5

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

"Find QRdx docs pages for a question or some key words" gives a specific verb plus resource, then enumerates the kinds of content covered (feature behavior, API endpoints/fields, limits and plans, React library). It also names read_docs_page as the follow-up tool, framing its own role as the discovery step. The only gap is that it never distinguishes itself from search_community, the other search-flavored sibling.

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?

The description tells the agent when this applies (questions about how features work, API details, limits/plans, the React library) and gives an explicit next step: "Pass a result's path to read_docs_page." It also sets a language precondition (search in English). It stops short of exclusions or of contrasting with search_community, so it is clear context without a full when-not rule.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.