Skip to main content
Glama

docs_read

Read a specific documentation page by source ID and page path, or list all pages in a source when page path is omitted.

Instructions

Read a specific documentation page. Provide sourceId and pagePath to read the full content. If pagePath is omitted, lists all pages in the source.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pagePathNoThe page path within the source (e.g., "hooks/useEffect"). If not provided, lists all pages in the source.
sourceIdYesThe source ID (e.g., "react", "nextjs")

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the two operating modes (read one page vs. list all), but says nothing about auth requirements (despite a docs_auth sibling), error behavior for invalid sourceId/pagePath, or response shape. Read-only nature is only implied.

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, with the core action front-loaded and the conditional mode immediately after.

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

Completeness3/5

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

With no output schema and no annotations, the description is the only behavioral source. It covers the main mechanics but omits authentication prerequisites and result shape, which are material for a docs retrieval tool in a suite containing docs_auth.

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 each parameter's description already explains its role, including the omitted-pagePath behavior, so the schema does the heavy lifting. The description repeats this without adding format or validation detail (e.g., what a valid sourceId looks like beyond examples).

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+resource ('Read a specific documentation page') and discloses the dual-mode behavior when pagePath is omitted. It does not explicitly distinguish itself from siblings like docs_list or docs_search, which could plausibly retrieve the same content.

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?

The description gives a clear conditional ('If pagePath is omitted, lists all pages'), which implies usage but doesn't state when to prefer this over docs_list, docs_search, or docs_preview for retrieval.

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