Skip to main content
Glama

Read a documentation page

get_doc_page
Read-onlyIdempotent

Read one documentation section of a control as Markdown — installation steps, canvas or model-driven configuration, examples, limitations. Use list_doc_sections first for the sections that control publishes; use get_component instead for the structured property reference. Passing a version returns the documentation pinned to that release rather than the current page. A section the control does not document returns an error pointing at list_doc_sections, and the Markdown comes back without the frontmatter the site keeps.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe control's slug, e.g. "pcf-tag-list".
sectionYesWhich section to read.
versionNoDocumentation pinned to a specific release. Defaults to the current documentation.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesAbsolute URL of the page, for citing.
titleYes
sectionYes
versionNoThe release this documentation describes.
contentMdYesThe page as Markdown, with its frontmatter removed. Empty when the page has no content.
sourceUrlNoThe file in the author's repository this was compiled from.
updatedAtNoISO 8601.
descriptionNo
componentNameYes
componentSlugYes
isVersionPinnedYesTrue when a version was asked for, rather than the current documentation being returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "componentName": {
      +      "type": "string"
      +    },
      +    "componentSlug": {
      +      "type": "string"
      +    },
      +    "contentMd": {
      +      "description": "The page as Markdown, with its frontmatter removed. Empty when the page has no content.",
      +      "type": "string"
      +    },
      +    "description": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "isVersionPinned": {
      +      "description": "True when a version was asked for, rather than the current documentation being returned.",
      +      "type": "boolean"
      +    },
      +    "section": {
      +      "enum": [
      +        "overview",
      +        "installation",
      +        "canvas",
      +        "model_driven",
      +        "api",
      +        "examples",
      +        "limitations",
      +        "faq",
      +        "migration",
      +        "changelog"
      +      ],
      +      "type": "string"
      +    },
      +    "sourceUrl": {
      +      "description": "The file in the author's repository this was compiled from.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "title": {
      +      "type": "string"
      +    },
      +    "updatedAt": {
      +      "description": "ISO 8601.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "url": {
      +      "description": "Absolute URL of the page, for citing.",
      +      "type": "string"
      +    },
      +    "version": {
      +      "description": "The release this documentation describes.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "componentSlug",
      +    "componentName",
      +    "isVersionPinned",
      +    "section",
      +    "title",
      +    "contentMd",
      +    "url"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds useful behavioral context: version pinning behavior, error behavior for undocumented sections (points at list_doc_sections), and the fact that Markdown comes back without frontmatter. This goes beyond the annotations without contradicting them.

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?

Four sentences, each earning its place: what it returns, how to discover sections, when to use the sibling, version behavior, and error behavior. The most important information is front-loaded.

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?

The tool has an output schema, so return values need no explanation. The description covers discovery flow, sibling routing, version behavior, and error handling. Nothing an agent needs to call it correctly is missing.

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 the schema already documents all three parameters. The description adds context about the version parameter (pins to a release) and the section parameter (which sections exist), but doesn't add much beyond the schema. Baseline 3 is appropriate.

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?

The description states a specific verb ('Read'), a specific resource ('one documentation section of a control'), and the output format ('as Markdown'). It also names the sibling tools it is not (list_doc_sections, get_component), so an agent can distinguish it from alternatives without opening schemas.

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?

The description explicitly says to use list_doc_sections first to discover sections, and to use get_component instead for the structured property reference. It also explains the version parameter's behavior. This is clear when-to-use guidance with named alternatives.

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