Skip to main content
Glama

Read a docs page

read_docs_page
Read-onlyIdempotent

Full text of one documentation page, by a URL from search_docs or list_docs_sections.

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_docs_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYes

Output Schema

NameRequiredDescriptionDefault
urlYes
titleYes
contentYes
sectionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so safety and repeatability are structured data. The description adds that the result is the page's full text (scope of return, not truncated), which is modest additional value beyond the annotations; it says nothing about error behavior for invalid or external URLs.

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?

A single compact sentence with the resource front-loaded and the precondition trailing as a qualifier. Nothing is wasted and nothing essential is buried.

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?

An output schema exists, so return-value details need not be described, and the tool has one required parameter with a clear provenance rule. Annotations cover the safety profile; an agent has everything needed to select and call this correctly.

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 description coverage is 0% for the single required url parameter, so the description must carry the meaning, and it does constrain the value to a URL produced by search_docs or list_docs_sections. However, it adds no format details (absolute vs relative, path shape) beyond that provenance hint; with one simple parameter this is adequate but not rich.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ("Full text of one documentation page") and even specifies the addressing scheme (by URL). It distinguishes itself from the retrieval siblings by naming search_docs and list_docs_sections as the sources of a valid URL, though it does not explicitly say what those siblings return instead.

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 description gives a clear condition for use: you must have a URL obtained from search_docs or list_docs_sections, which implicitly routes discovery to those tools and full-text retrieval here. It does not state exclusions (e.g., what to do if the URL is unknown or the page is missing), so it stops short of 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.