Skip to main content
Glama

eSignStack Docs

Read documentation page

read_doc
Read-onlyIdempotent

Read one documentation page or API operation in full, by the slug that search_docs returned (for example "webhooks", "mcp" or "api:post /webhook_endpoints").

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 from search_docs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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, non-destructive, and closed-world, so the safety profile is covered. The description adds genuine context beyond them: results are the complete page ("in full"), and slugs may address either narrative pages or individual API operations. It does not mention behavior for large pages or invalid slugs, a minor 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?

A single sentence with the action and scope up front, followed by the slug provenance and format examples. Nothing is redundant and every clause carries information.

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 and no output schema, the definition supplies the essentials: what is retrieved, how the slug is obtained, and its format. Only edge-case behavior (missing or invalid slugs, very long pages) is left unstated.

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% and already explains the slug's origin, but the description adds real semantic value by showing the slug grammar with concrete examples, including the prefixed form "api:post /webhook_endpoints" for operations, which the schema does not convey.

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 one documentation page or API operation") with explicit scope ("in full"), and distinguishes itself from search_docs by being the follow-up retrieval step keyed to a returned slug.

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 the slug that search_docs returned" clearly establishes the workflow position: search first, then read the chosen result. It stops short of stating when not to use it (e.g., use search_docs for discovery), but the context is unambiguous.

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