Skip to main content
Glama

read_doc

Read-onlyIdempotent

Retrieve full documentation pages or specific sections by path and heading anchor. For large pages, returns an outline to select a subsection; tables are delivered in numbered parts.

Instructions

Read a documentation page, or one section of it.

path is what search_docs returns, e.g. "claude-code/en/hooks". Pass section (a heading or its anchor, at any depth) to read just that part — required for very large pages, which otherwise return an outline to choose from.

A section that is one huge table — en/settings § Available settings, en/env-vars § Variables — has no subheadings to outline, so it comes back in parts, each carrying the table's header row. The reply names the part count; pass part=2, part=3… for the rest, or use grep_docs to pull a single entry out of it.

The Related pages footer is the page's own outgoing cross-references — what its authors thought you should read next. Follow them when the question spans more than the one page you happened to land on.

Indexed sources: claude-code (Claude Code), codex (OpenAI Codex), cursor (Cursor), opencode (opencode), xai (xAI / Grok).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
partNo
pathYes
sourceNoOne of: claude-code (Claude Code), codex (OpenAI Codex), cursor (Cursor), opencode (opencode), xai (xAI / Grok)
sectionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Annotations already indicate read-only, idempotent, non-destructive. Description adds behavior: large pages return outline, tables come in parts with header row, part parameter for pagination, and Related pages footer. No contradiction.

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?

Well-structured into paragraphs, front-loaded with core action. Each sentence adds value: section, part, table handling, cross-references. No waste.

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?

Has output schema (not shown) so return format likely covered. Description addresses purpose, param usage, edge cases (large pages, tables), cross-references, and sources. Complete given complexity and annotations.

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

Parameters5/5

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

Schema coverage is low (25%). Description explains path (from search_docs), section (heading or anchor), part (for large tables), source (listed). Also explains default behavior (outline if no section). Adds essential meaning beyond schema.

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?

Clear verb 'Read' and resource 'documentation page or one section of it'. Distinguishes from siblings like search_docs (returns paths) and grep_docs. Explains optional section and part for large pages.

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?

Provides usage context: when to use section (large pages), how to handle huge tables (part), and following cross-references. Lists indexed sources. Could explicitly say when not to use, but implies alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kiyeonjeon21/anydocs'

If you have feedback or need assistance with the MCP directory API, please join our Discord server