Skip to main content
Glama

read_doc

Read-only

Read a Gamebeast documentation page as markdown. Pass a path from search_docs (or a docs URL); add section (a heading anchor) to read only that part. The first read of a page lists its headings. Long content comes back in chunks: when the result has nextOffset, call again with offset set to it to continue.

Input Schema

NameRequiredDescriptionDefault
pathYesPage path such as '/sdk/roblox/api/configs', or a full docs URL (with #anchor).
offsetNoContinue a long page from a previous result's nextOffset.
sectionNoHeading anchor to read just that section, e.g. 'shared-methods'.

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=true and openWorldHint=false, so safety is covered; the description adds non-obvious runtime behavior instead: the first read of a page returns its heading list, and long pages are chunked with a nextOffset cursor. Return-shape details are not spelled out, but the pagination contract is the important part and it is explicit.

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?

Four tight sentences, front-loaded with the core action, then narrowing, then pagination — no filler or repetition of the schema. Every sentence carries information the agent needs to call the tool correctly.

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?

With only three input parameters, no output schema, and annotations covering the safety profile, the description supplies exactly the missing pieces: path provenance, section narrowing, and the chunked-read loop. Nothing an agent needs in order to invoke this correctly appears to be 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 each parameter already has an example, so baseline would be 3; the description goes slightly further by explaining the relationship between the parameters — path sourced from search_docs, section as a heading anchor, and offset strictly set from a prior nextOffset. That cross-parameter workflow is meaning the schema alone does not convey.

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 and resource ("Read a Gamebeast documentation page as markdown") and immediately positions it against the sibling search_docs by saying the path comes from there. An agent can distinguish this retrieval tool from search_docs without opening either schema.

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?

Gives clear prerequisites and workflow: obtain a path from search_docs (or a docs URL), optionally narrow with a section anchor, and continue with offset when nextOffset is returned. It does not explicitly state when not to use it (e.g., prefer search_docs when the path is unknown), but the implied sequencing is strong enough to act on.

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