Skip to main content
Glama

Proa documentation

get_doc

Read-onlyIdempotent

Read a complete official Proa documentation page as Markdown with its title, description, and canonical route. Supply a path returned by search_docs or resources/list. Only published documentation is accessible; arbitrary URLs and filesystem paths are not fetched.

Input Schema

NameRequiredDescriptionDefault
pathYesPublished route or Markdown path, for example /docs/core/html-rendering.

Output Schema

NameRequiredDescriptionDefault
pathYes
titleYes
markdownYes
descriptionYes
markdown_urlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, and closed-world behavior. The description adds meaningful access constraints: only published documentation is accessible, and arbitrary URLs or filesystem paths are not fetched. It could say more about failure modes or auth, but the key behavioral boundaries are covered.

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?

Three short sentences, front-loaded with the core action and format, then sourcing and restrictions. No wasted text.

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?

For a single-parameter read tool with an output schema, the description covers purpose, valid inputs, and access boundaries. Nothing an agent needs to invoke it correctly 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 coverage is 100% and already documents the single path parameter with an example. The description nevertheless adds value by specifying where valid paths come from (search_docs or resources/list) and what kinds of paths are invalid.

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 (official Proa documentation page), including the output format (Markdown) and returned metadata. It clearly distinguishes itself from the sibling search_docs by requiring a path that search_docs returns.

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 says to supply a path returned by search_docs or resources/list, and rules out arbitrary URLs and filesystem paths. This gives clear when-to-use and when-not-to-use guidance with the alternative tool named.

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