Skip to main content
Glama

Get documentation page

get_doc
Read-onlyIdempotent

Retrieve the full Markdown of a documentation page by path, or fetch a single section by anchor or heading. Use search_docs or list_docs to find paths.

Instructions

Return the full markdown of a documentation page by path, or a single section of it. Use search_docs or list_docs to find paths.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPage path from search_docs or list_docs, e.g. "guides/getting-started". Extensions and "docs://" prefix are accepted.
sectionNoReturn only this section: an anchor ("#install" or "install") or the heading text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, covering the safety profile. The description adds the return format (full markdown) and the section option, which is genuine added context, but it says nothing about behavior on nonexistent paths, anchoring misses, or pagination/size limits. Adequate but not rich.

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, zero waste. The return-shape statement is front-loaded and the routing hint follows immediately.

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?

No output schema exists, so the description carries the return-value burden and does so by naming the markdown format and the section-subset option. Combined with the rich annotations and 100% schema coverage, an agent has everything needed to invoke it 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 100%, so both 'path' (with its docs:// prefix and extension acceptance) and 'section' (anchor or heading text) are already fully documented in the schema. The description only restates that a path and optionally a single section are accepted, adding no syntax beyond the schema. 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 (Return full markdown) and resource (documentation page by path), plus the single-section variant. The mention of paths subtly separates it from the sibling tools, which are for discovery rather than retrieval.

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 routes the agent: 'Use search_docs or list_docs to find paths.' This names both alternatives and the condition under which they are needed, so an agent knows to call this tool only once it already has a path.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools