Skip to main content
Glama

Read a Documentation Page

read_doc
Read-onlyIdempotent

Fetch one guide as markdown. Takes the url that search_docs printed, for example "/api-conventions/". Only pages in the index can be read.

Input Schema

NameRequiredDescriptionDefault
urlYesPage path as search_docs printed it, e.g. "/credits/" or "/en/errors/".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/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, closed-world). The description adds value beyond them by disclosing the return format (markdown) and the index-membership restriction on valid inputs.

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, zero waste, front-loaded with the action and output format before the input-origin and constraint details.

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?

For a single-param read tool with no output schema, the description covers action, output format (markdown), how to obtain the required input, and the validity constraint. Nothing needed to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description earns above it by tying the url value to its origin ('the url that search_docs printed'), clarifying the expected path format beyond the schema's example strings.

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?

States a specific verb and resource with output format: 'Fetch one guide as markdown.' It distinguishes itself from search_docs by requiring a single page url, but does not contrast with list_docs or find_endpoint, leaving sibling differentiation partly implicit.

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 a clear prerequisite workflow: take the url that search_docs printed, and notes 'Only pages in the index can be read' as an eligibility constraint. It stops short of naming when NOT to use this tool or which sibling to pick for other needs.

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