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 it after finding paths with search tools to read exact docs content.

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

NameRequiredDescriptionDefault
pathYesPage path from search_docs or list_docs, e.g. "guides/getting-started" (extensions and "docs://" prefix are accepted), or a full https:// URL to the page, optionally with a #fragment.
sectionNoReturn only this section: an anchor ("#install" or "install") or the heading text. Defaults to the #fragment of `path` when `path` is a URL.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.4.1
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / path / description
      Previous value: -"Page path from search_docs or list_docs, e.g. \"guides/getting-started\". Extensions and \"docs://\" prefix are accepted."New value: +"Page path from search_docs or list_docs, e.g. \"guides/getting-started\" (extensions and \"docs://\" prefix are accepted), or a full https:// URL to the page, optionally with a #fragment."
    • changedInput schema / properties / section / description
      Previous value: -"Return only this section: an anchor (\"#install\" or \"install\") or the heading text."New value: +"Return only this section: an anchor (\"#install\" or \"install\") or the heading text. Defaults to the #fragment of `path` when `path` is a URL."
  2. First observedv0.1.0

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 and closed-world, so safety is covered; the description adds the genuinely useful behavioral fact that the payload is markdown and can be narrowed to one section. It does not cover error behavior for missing paths, so it is not fully complete.

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 capability and the section variant come first, and the sibling routing comes second. Nothing could be removed without losing 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 two-parameter read tool with no output schema, the description supplies the essential missing piece (return format = markdown, optionally one section) on top of fully documented params and annotations. Only edge behavior on invalid paths is left unstated.

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 coverage is 100% and the schema itself documents path formats, URL/fragment acceptance and section anchor/heading forms in more detail than the description. The description only restates 'by path, or a single section', so the 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 ('Return the full markdown of a documentation page') plus the scope variants (whole page or single section). Together with naming search_docs/list_docs as path finders, an agent can distinguish it from its siblings without opening any schema.

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?

Explicitly routes discovery to search_docs or list_docs and reserves get_doc for fetching content by path, which gives clear usage context. It stops short of stating exclusions or failure conditions (e.g., what to do if the path is unknown).

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