Skip to main content
Glama

OTInstaller Registry

Read a guide page

read_guide
Read-onlyIdempotent

One page of a guide, as Markdown, with the list of its pages and the tools it uses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNothe page path from pages; the first page by default
guideYesthe guide, namespace/name or namespace/name@version

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnly, idempotent, openWorld=false, non-destructive), so the description's real contribution is disclosure of the payload: Markdown plus the page list plus the tools the page references. That tells the agent what a call yields beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence with no filler, and the key fact (Markdown page) is front-loaded. It is slightly telegraphic — the reading action itself is never stated — but there is no wasted text.

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?

With no output schema, the description must describe the return value, and it does: one page in Markdown, the list of pages, and the tools used. Pagination behavior across pages is not mentioned, but for a two-param read tool the coverage is nearly sufficient.

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 both guide and page are already documented in the schema, including the page default and the namespace/name@version format. The description adds nothing parameter-specific, which is acceptable but sets the baseline at 3.

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?

The description names a specific resource (a guide page) and its return format (Markdown), so an agent can tell it apart from search_guides. The verb is implicit rather than stated ('One page of a guide' rather than 'Reads/returns'), and no sibling is named, but the resource is unambiguous.

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

Usage Guidelines2/5

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

There is no guidance on when to use this versus search_guides, list_types, or get_tool, nor any precondition. The only usage-relevant detail — that page defaults to the first page — is carried by the schema, not the description.

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.