Skip to main content
Glama

render

Returns a PNG image of the Inkboard whiteboard to visually check your work without changing the board. Optionally frames a region or object IDs and can label visible IDs for editing.

Instructions

Returns a PNG picture of the board (or of a part of it) as an image, to check your work visually. Read-only: the board, the file and the undo history are untouched. By default the whole page content is shown. region {x, y, w, h} (board units) shows exactly that rectangle; ids frames the given objects (plus padding) while still drawing their surroundings; give either, not both. show_ids: true draws a small white badge with the id of every visible object (top-left corner; middle of an arrow) so you can link what you see to the ids that update_object or add_connector expect (pen strokes get none). The longest side is max_px pixels (default 1400, 16 to 3000; a small region is enlarged 4 times at most); a PNG above 4 MiB is automatically produced smaller (said in note). output also writes the PNG to a .png file under the allowed root, for clients that do not display images. Text is measured approximately, as in export.

Input Schema

NameRequiredDescriptionDefault
idsNoIds of the objects to frame (not combinable with `region`).
pageNoPage: number (from 1) or name. Defaults to the first.
pathNoPath of the board file (.inkboard; .inkboard.json and .tableau.json also accepted). Optional when the application is open: the tool then acts live on the displayed board (undoable with Ctrl+Z).
max_pxNoLongest side of the image in pixels. Default 1400.
outputNoAlso write the PNG to this file (must end with .png, under the allowed root).
regionNoRectangle of the board to show, in board units (as the x/y/w/h of describe_board). Padding is not added.
paddingNoMargin around the content or the framed ids, in board units. Default 24.
show_idsNoDraw the object ids on the picture. Default false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does so well: it declares 'Read-only: the board, the file and the undo history are untouched', states defaults (max_px 1400, padding 24), the hard limits (16–3000 px, 4x max enlargement), and the automatic downscaling above 4 MiB surfaced via `note`. The only gap is that it never explicitly says what the returned payload looks like (image content vs. URI), which matters for a no-output-schema tool.

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?

Purpose is front-loaded in the first clause, followed by safety, then framing modes, then decoration, then sizing. Every sentence carries distinct operational information—defaults, caps, or edge cases—with no redundant restatement of the name.

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 an 8-parameter tool with a nested `region` object and no output schema, the description covers framing modes, sizing limits, file output, and read-only safety. The main missing piece is the shape of the response (how the image is returned, what `note` contains in the normal case), which matters given there is no output schema to fall back on.

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%, so the baseline is 3, but the description adds genuine meaning beyond the schema: `show_ids` badge placement (top-left corner, middle of arrows), that pen strokes get no id, that `region` adds no padding, and the ids-vs-region exclusivity. It stops short of explaining `page` or `path` semantics beyond what the schema already says, keeping it at a 4 rather than 5.

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?

Opens with a specific verb and resource ('Returns a PNG picture of the board') plus scope options (whole page, region, ids). It distinguishes itself from siblings by naming what it is for ('to check your work visually') and referencing `export`, `update_object`, and `add_connector` as related tools, so an agent can separate it from export/describe_board without opening schemas.

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

Usage Guidelines5/5

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

Gives explicit when-to-use ('to check your work visually'), mutually exclusive alternatives for framing ('give either, not both' for region vs ids), and a condition for the `output` parameter ('for clients that do not display images'). The routing logic between the two framing modes is fully spelled out rather than implied.

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