Skip to main content
Glama

Read a Parallax doc

read_doc
Read-onlyIdempotent

Returns a page of the Parallax documentation or a PIP in full, as Markdown: by "path" from search_docs (such as "hashwarp/pool-mining" or "pip-0004"; "PIP-4", a parallax://docs URI or a docs.parallaxprotocol.org URL also work). Long pages come in parts of "max_bytes" (default 24,000): pass "next_offset" back as "offset" for the rest. Includes the page's published url, to cite.

Input Schema

NameRequiredDescriptionDefault
pathYespage path from search_docs, such as hashwarp/pool-mining or pip-0004
offsetNobyte offset to start from, for long pages (next_offset of the previous call)
max_bytesNohow much to return, 1000-120000 bytes (default 24000)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / path / description
      Previous value: -"page path from search_docs, such as guides/mining/pool or pip-0004"New value: +"page path from search_docs, such as hashwarp/pool-mining or pip-0004"
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, openWorld, and non-destructive, so safety is covered. The description adds genuinely useful non-annotation behavior: pagination via max_bytes/offset with next_offset chaining, Markdown output, and the inclusion of a citeable published URL. No auth or rate-limit details, hence not a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose and return format, then pagination and path-format details. Dense but every clause carries information; the parenthetical path examples make it slightly heavy though none is wasted.

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 3-param read tool with no output schema, it covers what is returned (Markdown page/PIP), how to page through long content, and that a URL is included for citation. Nothing an agent needs to invoke 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, but the description adds accepted path variants beyond the schema ('PIP-4', parallax:// URIs, docs.parallaxprotocol.org URLs) and explains the offset/max_bytes relationship dynamically. Offset semantics are slightly clarified but the schema already documents the byte range.

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?

States a specific verb and resource ('Returns a page of the Parallax documentation or a PIP in full') and fixes the output format (Markdown). It positions itself against search_docs by naming it as the source of the path, so an agent can distinguish read from search without opening a schema.

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?

The phrase 'by "path" from search_docs' tells the agent where the required input comes from, effectively routing it to search_docs first. It stops short of an explicit 'use search_docs if you don't know the path' instruction or any exclusion of alternatives, so it is clear context rather than full when/when-not guidance.

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.