Skip to main content
Glama

Read a canvas

get_canvas
Read-onlyIdempotent

Read one of the user's canvases: its name, groups and an outline of the cards on it (type, name, prompt, note text, status, which cards feed into which, a popnow:// link and a short-lived preview link for finished media). Big canvases come in pages: pass next_offset as offset to read more. Reuse the popnow:// links as inputs for other PopNow tools, and the card ids for add_to_canvas. Free and read-only.

Input Schema

NameRequiredDescriptionDefault
limitNoHow many cards to show, 1 to 60. Default 30.
offsetNoCard to start from when reading a big canvas page by page: pass next_offset from the previous answer. Default 0.
canvas_idYesThe canvas id from list_canvases (it starts with b_).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotent/non-destructive, so the bar is lower; the description still adds real behavior: pagination via next_offset, short-lived preview link expiry, and that the call is free. Those are traits the annotations cannot express.

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?

Front-loads the return contents, then pagination, then cross-tool link reuse. One long first sentence is dense but every clause carries information; no filler.

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 correctly carries the burden of describing return values and does so in detail, including pagination semantics. Only the exact shape of the 'outline' and preview link lifetime is left vague.

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 100%, so canvas_id, limit and offset are already documented in the schema. The description reinforces the offset/next_offset round-trip but adds little that the schema doesn't already state, so the baseline 3 applies.

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 one of the user's canvases') and immediately enumerates what is returned: name, groups, card outline fields, links. An agent can distinguish it from list_canvases or open_canvas purely from this text.

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 concrete downstream guidance: 'pass next_offset as offset to read more', 'Reuse the popnow:// links as inputs for other PopNow tools, and the card ids for add_to_canvas.' It does not explicitly say when to prefer this over list_canvases or open_canvas, but the operational context is clear.

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.