Skip to main content
Glama

Read a QRdx docs page

read_docs_page
Read-onlyIdempotent

One QRdx docs page as Markdown, by its path from search_docs (/docs/developers/mcp) or its URL. Long pages are cut at 12,000 characters with a link to the rest. Pages are in English.

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": {
      "path": "<path>"
    },
    "name": "read_docs_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe page's path from search_docs, such as /docs/developers/rest-api, or its full URL.
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. Changed1 schema field 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."
  2. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), so the description rightly spends its words elsewhere: the 12,000-character truncation with a link to the remainder and the English-only content are non-obvious behaviors an agent must plan around. It does not say whether the link is a follow-up tool call or a URL.

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

Conciseness5/5

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

Three short sentences, front-loaded with what the tool returns, then the input source, then the truncation and language caveats. No filler and nothing repeated.

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 carries the burden of describing return values, and it does: Markdown, truncated at 12,000 characters with a link onward, English only. For a two-parameter read tool that is everything needed to call it correctly.

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 coverage is 100%, so both parameters are already documented in the schema, including the ignored 'language' parameter. The description reinforces that pages are English-only but adds no format or fallback detail beyond what the schema states; baseline 3 applies.

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 verb and resource ('One QRdx docs page as Markdown') plus the addressing scheme ('by its path from search_docs ... or its URL') and the return format. It is distinguishable from search_docs purely from the text: one page versus a search.

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 phrase 'by its path from search_docs' gives an explicit workflow cue — call search_docs first, then read a result. There is no stated when-not or a named alternative for retrieving multiple pages, so it falls short of full routing guidance.

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.