Skip to main content
Glama

Zain Ahmed Documentation MCP Server

get_documentation_page

Read-only

Use this tool when reading a specific documentation page, architecture blueprint, SDK guide, or OpenAPI 3.1 specification by topic slug. Returns the complete Markdown or JSON document content for that page.

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": "get_documentation_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesDocumentation page slug

Output Schema

NameRequiredDescriptionDefault
contentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds real context on top: the call returns the complete document (not a snippet) and the payload is Markdown or JSON. It doesn't mention truncation limits or behavior on unknown slugs, but notable gaps.

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, both earning their place: the first is front-loaded with the usage condition and page kinds, the second covers the return shape. No filler or restatement of the title.

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?

With an output schema present and annotations covering the safety profile, the description needn't detail return structure, and it still notes the content format. Only the lack of routing guidance against discovery tools keeps it from complete.

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 goes slightly beyond "Documentation page slug" by explaining that slugs address distinct page categories (architecture, SDK guide, OpenAPI 3.1 spec), which tells the agent what kind of content each choice yields.

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 and resource: reading a single documentation page by topic slug, and enumerates the page kinds (architecture blueprint, SDK guide, OpenAPI 3.1 spec). An agent can distinguish this from a search-style sibling, though no sibling is named explicitly.

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?

"Use this tool when reading a specific documentation page ... by topic slug" gives a clear selecting condition: known-topic, whole-page retrieval. It stops short of explicit exclusions or naming an alternative such as search_docs for discovery-first lookups.

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