Skip to main content
Glama

Read example pages

get_examples
Read-only

Up to 4 of the studio's example pages, by the ids listed in a page brief — read the ones that fit the page you are about to write.

Input Schema

NameRequiredDescriptionDefault
idsYesUp to 4 example ids from the page brief's list, e.g. ["L3", "R12"].
deck_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / properties / guest_token
      Removed value: -{
      -  "description": "Only for a deck created WITHOUT an account: the guest_token create_deck returned.",
      -  "maxLength": 80,
      -  "type": "string"
      -}
  2. Added

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds the useful constraint that at most 4 pages are returned and where the ids come from, but says nothing about the shape or size of what comes back.

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?

A single sentence with no filler; the cardinality limit and the routing condition are front-loaded and both earn their place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 carries the burden of explaining what a returned example page contains, and it only implies this. Combined with the undocumented deck_id, the definition is usable but leaves real gaps for a read tool whose return value is the whole point.

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 coverage is 50%: 'ids' is documented in the schema with format and an example, while 'deck_id' has no description anywhere. The description supplements the ids parameter by tying it to the page brief's list, which is genuine added meaning, but the undocumented deck_id keeps this at a baseline 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 verb (read) and resource (the studio's example pages) and states the cardinality cap ('up to 4'), which cleanly separates it from siblings like read_page and get_page_brief. It stops short of explicitly naming an alternative tool, but an agent can tell what this does without opening the 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?

'Read the ones that fit the page you are about to write' gives a clear situational trigger, and the reference to ids 'listed in a page brief' implies the get_page_brief → get_examples workflow. There is no explicit when-not guidance or named sibling to avoid, so it falls short of a 5.

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.