Skip to main content
Glama

DeveloperHub Docs

Read page

read_page
Read-only

Read a documentation page as Markdown. Pass its URL as search or list_pages gives it, or its path on this site. For a section's pages call list_pages, and for an API reference list_endpoints and read_endpoint.

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": {
      "url": "<url>"
    },
    "name": "read_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesThe page's URL, or its path on this site

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds the output format (Markdown) and the provenance of the URL argument, but says nothing about failure on an unknown page or size/truncation limits. Useful but thin beyond the structured data.

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?

Two sentences, front-loaded with what the tool does and what it returns, then input sourcing and routing. No filler, though the second sentence packs several sibling references into one dense clause.

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 one-parameter read tool with no output schema, the description covers action, return format, and input sourcing. The only remaining gap is error behavior for invalid or nonexistent pages, which is minor here.

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% and the single 'url' parameter is already documented as 'The page's URL, or its path on this site'. The description echoes that same duality and adds the provenance hint (the value search/list_pages returned), which is marginally helpful but largely restates the 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?

States a specific verb and resource ('Read a documentation page') plus the return format ('as Markdown'), which immediately separates it from read_endpoint, which serves API references.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly tells the agent where the input comes from ('as search or list_pages gives it, or its path on this site') and routes to alternatives by intent: list_pages for a section's pages, list_endpoints and read_endpoint for API references.

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.

Resources