Skip to main content
Glama

Read page

read

Retrieve documentation pages from a DevDocs docset as markdown, using anchors to target sections and offset pagination for long pages.

Instructions

Read a docset page as markdown. Append #anchor to the path to get just that section. Long pages paginate via offset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPage path from search/toc, optionally with #anchor.
docsetYesDocset slug, e.g. 'vite'.
offsetNoCharacter offset into the markdown (from a truncation hint).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

No annotations are present, so the description carries the behavioral burden. It discloses the markdown output, the #anchor behavior, and pagination via offset. This is solid coverage for a read-only tool, though it omits error behavior and the precise pagination protocol.

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 concise sentences, with the primary purpose front-loaded and the pagination detail following naturally. Every sentence earns its place with no redundancy.

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 simple read tool, the description covers the core behavior, markdown output, section anchoring, and pagination. It does not address errors or absent pages, but the missing details are unlikely to block correct invocation.

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 description coverage is 100%, but the description adds meaning beyond the schema by explaining how #anchor affects the path and that long pages paginate via offset. This enriches the schema's bare parameter definitions.

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?

The description clearly states 'Read a docset page as markdown' — a specific verb and resource. This distinguishes it from sibling tools like remove_docset, search, toc, and install_docset.

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?

The description does not explicitly state when to use this tool versus alternatives such as search or toc. The path schema hints that paths come from search/toc, but the description itself gives no usage guidance or exclusions.

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

Deploy Server

Other Tools