Skip to main content
Glama
Sign In
docs-mcp-server

docs-mcp-server

by arabold
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

read_page

Read-only

Retrieve the full content of an indexed documentation page by library and URL or path; long pages return in parts with continuation details.

Instructions

Read the full content of an indexed documentation page, for example a URL returned by search_docs or list_pages. Long pages are returned in parts; the response says how to continue.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "library": "<library>",
      "pathOrUrl": "<pathOrUrl>"
    },
    "name": "read_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
libraryYesLibrary name.
versionNoLibrary version (exact or X-Range, optional).
maxCharsNoMaximum characters to return (default 30000). Only whole chunks are returned, so a single longer chunk is returned on its own.
pathOrUrlYesPage URL, or a path matching the end of one page URL (e.g. 'https://react.dev/reference/react' or '/reference/react').
startChunkNoChunk to start from, as given by a previous response (default 0).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.4.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare a safe read-only operation, but the description adds behavior those annotations don't cover: long pages come back in parts and the response explains how to continue. That pagination trait is the key non-obvious behavior for this tool. It doesn't mention rate limits or index staleness, but for a read tool this is solid added context.

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 sentences, front-loaded with the core purpose, then the pagination caveat. Every clause carries information an agent needs, with no repetition of the schema or the title.

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 read tool with five parameters, no output schema, and full schema coverage, this is essentially complete: the description signals that the result may be partial and self-describes how to continue. Minor omission is any mention of what happens with ambiguous path matches or missing pages.

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 coverage is 100%, so every parameter is already documented, including maxChars chunking and startChunk continuation. The description reinforces the chunk/continuation model at the semantic level but adds no syntax or format detail beyond the schema, so the baseline of 3 applies.

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 states a specific verb ('Read') and resource ('full content of an indexed documentation page') and anchors it to URLs produced by search_docs or list_pages, which separates it from the search/list siblings. The word 'indexed' implicitly distinguishes it from the generic fetch_url sibling.

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?

It gives a clear usage context: call this with a URL returned by search_docs or list_pages, i.e. the follow-up step to discovery. It stops short of explicit exclusions, such as directing non-indexed or arbitrary URLs to fetch_url, so an agent must infer that boundary.

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