Skip to main content
Glama

cnvs.app

by app.cnvs
OverviewDiscussionsAdmin

Get Board Preview

get_preview
Read-only

Compact schematic SVG render of the board (typically a few kB even for dense boards). Returns both an image/svg+xml content block (you can SEE it) and the raw SVG text. CALL THIS any time you need to understand where things are — before placing new items, before deciding whether the canvas is crowded, before picking a free region. AI-authored items get a purple border so you can tell which contributions were yours. For precise text content prefer get_board.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
board_idYes
access_keyNo8-character lowercase alphanumeric board access key when the board is locked (legacy 6-character lowercase alphanumeric keys are also accepted). Equivalent to setting the `X-Board-Key` HTTP header on the JSON-RPC POST. Omit for unlocked boards. Obtain via POST /api/boards/<id>/lock.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / access_key / description
      Previous value: -"6-char board access key (a-z, 0-9) when the board is locked. Equivalent to setting the `X-Board-Key` HTTP header on the JSON-RPC POST. Omit for unlocked boards. Obtain via POST /api/boards/<id>/lock."New value: +"8-character lowercase alphanumeric board access key when the board is locked (legacy 6-character lowercase alphanumeric keys are also accepted). Equivalent to setting the `X-Board-Key` HTTP header on the JSON-RPC POST. Omit for unlocked boards. Obtain via POST /api/boards/<id>/lock."
  2. Changed1 schema field changed
    • addedInput schema / properties / access_key
      Added value: +{
+  "description": "6-char board access key (a-z, 0-9) when the board is locked. Equivalent to setting the `X-Board-Key` HTTP header on the JSON-RPC POST. Omit for unlocked boards. Obtain via POST /api/boards/<id>/lock.",
+  "type": "string"
+}
  3. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the accessible readOnlyHint and destructiveHint annotations, the description discloses that it returns both an image/svg+xml content block and raw SVG text, and that AI-authored items are visually marked with a purple border. It also sets accurate size expectations (a few kB) that help the agent predict the response type and size.

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 front-loaded with the core output characteristic, then adds actionable usage guidance, a critical visual differentiator, and an alternative-tool pointer. Every sentence contributes meaningful selection or invocation information, with no wasted prose.

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?

Given no output schema, the description adequately fills in what the tool returns (SVG image block and raw text), the visual format, and why an agent would call it. It orients the agent within the larger tool family and provides enough behavioral detail to make a confident selection and invocation decision.

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?

The schema already fully documents `access_key`, and `board_id` is straightforwardly identified by the tool name and preview context. The description adds little parameter-level meaning beyond that, but given only two parameters and one requiring no special semantics, the gap is acceptable.

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 this tool renders a compact schematic SVG of the board and distinguishes it from `get_board` by noting that `get_preview` is for visual/spatial understanding while `get_board` is preferred for precise text content. The verb+resource pair is specific: it shows/serves board preview, not general board data.

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?

The description gives explicit use cases: use it before placing new items, before deciding whether the canvas is crowded, and before picking a free region. It also names an alternative, `get_board`, for precise text needs, providing clear when-to and when-not-to guidance.

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

All cnvs.app toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources