Skip to main content
Glama

pandocs_get_page

Read a Game Boy Pan Docs chapter with custom syntax expanded into readable bit layouts, callouts, and resolved links. Use sections_only to locate the right section before fetching full content.

Instructions

Read a whole Pan Docs chapter.

Custom syntax is expanded: {{#bits}} tables become readable bit layouts, :::warning callouts become labelled blockquotes, and cross-references are resolved to real gbdev.io URLs. Pass sections_only=True first if you only need to find the right section.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesPage id, e.g. 'LCDC', 'Memory_Map', 'MBC1'.
sections_onlyNoReturn only the heading outline, not the text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations at all, the description carries the full behavioral burden. It does disclose a genuine behavioral trait: custom syntax is expanded into readable layouts, blockquotes, and real gbdev.io URLs. However, it says nothing about output size, error behaviors, or what the returned page content looks like beyond embellishment, leaving notable gaps for a tool with no annotations.

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?

The description is three compact and purposeful sentences. The first anchors the purpose, the second clearly transmits the output-transformation details, and the third gives actionable flag usage. Every sentence earns its place with no redundant or purely decorative wording.

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?

For a simple two-parameter read-only tool, the description covers what is returned, how syntax is transformed, and the intended first-step use of `sections_only=True`. It would be stronger if it named the sibling `pandocs_get_section` for direct section access or mentioned error behavior, but those are minor given the tool's simplicity.

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?

The JSON schema already gives full coverage for both parameters, so the baseline is 3. The description adds workflow meaning to `sections_only` by saying to pass it first when only needing the outline, which gives the agent a concrete rule for when to set that flag beyond the bare schema description.

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 clearly states the tool reads a whole Pan Docs chapter/page with a specific verb and resource. It anticipates the sibling tool pandocs_get_section by emphasizing 'whole' and telling the agent to use `sections_only=True` when looking for the right section, making it easy to distinguish page-body retrieval from section-level retrieval.

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

Usage Guidelines3/5

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

The delimiter 'whole' and the instruction to pass `sections_only=True` first imply a workflow, but the description does not explicitly name or compare against nearby siblings like pandocs_get_section or pandocs_toc. Usage guidance is present, but it is limited to parameter usage rather than an explicit when-to-use/alternatives contrast.

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