Skip to main content
Glama

docs

get_document

Read-onlyIdempotent

Read the Markdown representation of one canonical public Hyperwave page. Paths come from search_docs or the sitemap.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesCanonical site path, such as /guides/vital; no domain or query string

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
pathYes
titleYes
markdownYes
markdownUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds genuinely new context beyond them: the return is a Markdown representation, and only canonical PUBLIC pages are readable, hinting that non-public or non-canonical paths will fail.

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 short sentences, zero waste, with the core action front-loaded before the path-provenance note. Every clause carries information.

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?

Output schema exists so return shape needn't be explained, and annotations cover the safety profile. The description still supplies the two things neither structured field covers: output format (Markdown) and where valid inputs come from. Nothing essential for correct invocation is missing.

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 description coverage is 100% and the schema already specifies the path format (canonical site path, no domain/query string). The description adds meaning beyond the schema by telling the agent where valid path values originate (search_docs or the sitemap), which helps avoid hallucinated paths.

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 ("Read") and resource ("Markdown representation of one canonical public Hyperwave page"), with scope qualifiers (one, canonical, public). It also implicitly distinguishes itself from the sibling search_docs by positioning that tool as the source of paths rather than a reader of content.

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?

"Paths come from search_docs or the sitemap" clearly establishes the prerequisite workflow and routes the agent to the sibling for discovery versus this tool for retrieval. It stops short of stating when NOT to use it (e.g., when a search snippet already suffices), so no explicit exclusions.

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