Skip to main content
Glama

Read a documentation page

read_doc
Read-only

Returns one documentation page as Markdown. Free, and works without logging in.

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": {
      "id": "<id>"
    },
    "name": "read_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesA page id from list_docs, e.g. "curp/endpoints/curp-lookup".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, and the description adds genuinely useful context on top: the return format (Markdown) and the absence of an authentication requirement. It doesn't cover failure behavior for an unknown or stale page id, which is the main remaining gap for a lookup tool.

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?

Two short sentences with the return format front-loaded and no wasted wording. The second sentence's referent ('free' for which thing?) is the only element that costs clarity rather than earning space.

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

Completeness4/5

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

For a one-parameter read tool with no output schema, the description covers the essentials: what comes back (a Markdown page) and that no login is needed. Missing only error/id-validation behavior, which is minor at this complexity.

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% and the single id parameter is fully documented in the schema, including a concrete example and its origin in list_docs. The description adds nothing about the parameter, so baseline 3 applies.

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?

The description states a specific verb and resource ('Returns one documentation page') plus the output format ('as Markdown'), which is enough to distinguish it from list_docs and the verification siblings. The trailing clause 'Free, and works without logging in' is slightly ambiguous about whether it describes the tool or the documented API, which keeps it from a 5.

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

Usage Guidelines3/5

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

Usage is only implied: the description doesn't say when to call this versus list_docs, though the 'one documentation page' framing plus the id parameter's reference to list_docs makes the follow-up pattern inferable. The 'free, no login' note is context about access, not about tool selection.

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.

Resources