Skip to main content
Glama

ExducerAI GPU cloud

Read a documentation page

read_doc
Read-onlyIdempotent

One documentation page as Markdown, by its slug (from search_docs). Read the page before answering a question about how the platform works.

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": {
      "slug": "<slug>"
    },
    "name": "read_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesThe page slug, e.g. c-provisioning (from search_docs).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so safety is covered. The description adds value the annotations do not: the return payload is a single page rendered as Markdown, which sets expectations about the response shape. It does not mention failure behavior for an unknown slug, which is a minor remaining gap.

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, no filler. The return type and keying input are front-loaded, and the follow-on sentence carries the usage rule.

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 full annotation coverage, this covers purpose, input provenance, and output format. No output schema exists, but the description supplies the return format, which is the one thing an agent would otherwise lack.

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 100% and the schema already documents the slug with an example and its source (search_docs). The description repeats that provenance rather than adding new meaning, so baseline 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?

States a specific verb and resource ('read' a 'documentation page'), names the return format (Markdown), and names the keying input (slug). This clearly distinguishes it from the sibling search_docs, which only finds pages.

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?

Gives a concrete usage trigger — 'Read the page before answering a question about how the platform works' — and routes the agent to search_docs as the source of the slug. No explicit when-not-to-use case, but the pairing with its obvious sibling is clear.

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