Skip to main content
Glama

get_doc

Read-only

Fetch one documentation page's full markdown content. path may be a doc path ("learn/x.md"), a site route ("/docs/learn/x/"), or a full docs URL (including a ".md"-suffixed one).

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / properties / path / title
      Removed value: -"Path"
    • removedInput schema / title
      Removed value: -"get_docArguments"
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "title": "get_docDictOutput",
      -  "type": "object"
      -}New value: +null
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that the return value is the page's full markdown content and that path forms are normalized across three formats, but says nothing about not-found behavior, relative-path resolution root, or whether frontmatter is included.

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 action and return type come first, then the parameter formats that an agent would otherwise get wrong. Front-loaded and appropriately sized.

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 read-only, single-parameter tool with annotations but no output schema, the description tells the agent what it gets back and how to address the resource, which is the essential set. Only failure-path and path-resolution details are missing, which is a minor gap at this complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the single parameter is undocumented in the schema, so the description carries the full burden — and does so with three concrete accepted formats plus a note that '.md'-suffixed URLs work. That is more than the schema provides and directly prevents malformed calls.

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: 'Fetch one documentation page's full markdown content' — the words 'one' and 'full ... content' separate it from list_docs and search_docs without naming them. Sibling differentiation is achieved implicitly rather than explicitly, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the path-format enumeration (you can pass a doc path, route, or URL), but the description never says when to pick this over search_docs/list_docs or what a caller must already know (e.g. having found the path first). No exclusions or prerequisites are stated.

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