Skip to main content
Glama

Read an Open Play doc page

read_doc

Retrieves the complete Markdown for an Open Play documentation page by its ID, using IDs from search or list results; output is capped at 40,000 characters with a link to the full page.

Instructions

Returns the full markdown of one documentation page by its id (for example "auth/guest" or "guides/player-data"; ids come from search_docs or list_docs). Output is cut at 40000 characters with a link to the full page.

Input Schema

NameRequiredDescriptionDefault
langNoDocumentation language: "en" (default) or "tr" (the Turkish source).en
pageYesPage id such as 'auth/guest'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description usefully discloses the 40,000-character truncation behavior and that a link to the full page is provided. It does not discuss error behavior for invalid ids, permissions, or language fallback, but for a straightforward read tool the key behavioral caveat is 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?

Two tightly written sentences with no wasted wording. The core purpose and the truncation caveat are both front-loaded and easy to scan.

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 simple two-parameter read tool with no output schema, the description covers purpose, id provenance, return format, and truncation. The remaining parameter detail is fully handled by the schema, so nothing essential 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 both parameters are already documented, including the lang enum and default. The description adds a little meaning by giving page id examples and their source, but it does not meaningfully expand on parameter behavior beyond the schema.

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 and resource: it returns the full markdown of one documentation page by id. Naming the id source (search_docs or list_docs) and giving example ids makes it clearly distinct from the sibling search/list tools.

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?

It tells the agent when this tool applies by explaining that page ids come from search_docs or list_docs, which implies the retrieve-after-search workflow. It does not explicitly say when not to use it or name an alternative retrieval path, so it falls short of full when/when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.