Skip to main content
Glama

Read a docs page

read_doc
Read-only

One docs page as markdown, with its title, description, canonical URL and last-updated date. Name it by path, e.g. /docs/purchase.

Input Schema

NameRequiredDescriptionDefault
pathYesThe page's path or URL, e.g. /docs/purchase or /docs/budgets

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and destructiveHint=false, so safety is covered and the description carries a lighter burden. The description adds useful context beyond annotations by enumerating the returned fields and noting the markdown format, but it says nothing about error behavior for missing pages or response size.

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?

Two short sentences: the first front-loads the output contract, the second gives the identifier format. No filler, no repetition of the tool name.

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 single-parameter read tool with full schema coverage and safety annotations, the description covers what is returned and how to identify the page, which is enough to call it correctly. The remaining gap is routing guidance versus the sibling tools, which the description leaves unaddressed.

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 the sole parameter is already documented with examples. The description's example path and the schema's examples overlap heavily, adding little new meaning such as whether full URLs are accepted or how paths are normalized, so the 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 names a specific verb and resource (read one docs page) and states the return shape: markdown plus title, description, canonical URL and last-updated date. It implicitly distinguishes itself from list_docs and search_docs by returning a single page rather than a collection, though it never names those siblings explicitly.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance. The reader must infer that this is for fetching one known page and that list_docs/search_docs cover discovery, since neither sibling is mentioned and no conditions for choosing among them are given.

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