Skip to main content
Glama

Read a Whiteboard

read_board
Read-onlyIdempotent

Read a Whiteboard (an Artifact made with spec bisque-canvas/v1) as structure: its frames, every shape with its text and the frame it sits in, what each arrow connects, and an outline with frames as headings, shapes as bullets and arrows as A → B. Pass region to read one area. Use it before changing a board, to answer a comment about it, or to turn the board into a document or a presentation.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "artifact_id": "<artifact_id>"
    },
    "name": "read_board"
  }
}

Input Schema

NameRequiredDescriptionDefault
regionNoBoard coordinates of an area, as a comment pinned to a region carries them; only what overlaps it is returned.
artifact_idYesThe Artifact id (art_…): the last part of its link, as in bisque.cloud/documents/art_…, /pages/art_… or /artifacts/art_….

Output Schema

NameRequiredDescriptionDefault
urlNo
framesYes
shapesYes
outlineYes
truncatedYes
artifact_idYes

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, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description adds value beyond that by disclosing the shape of the response (structural frames/shapes/arrows plus an outline) and that region reads are overlap-based, though it says nothing about size limits or cost on very large boards.

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?

Two sentences, front-loaded with the resource and its spec, then the return structure, then usage. Every clause carries information. It is dense rather than padded, though the enumeration of return fields is long enough to slow scanning slightly.

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 four annotations, a fully documented two-parameter schema, a nested region object and a declared output schema, the description covers what the agent still needs: the structural form of the result and the situations that call for it. The only minor gap is guidance on behavior for very large boards or how partial region reads differ from full reads in practice.

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%, and both artifact_id (with its link-format pattern example) and region (with nested x/y/w/h and the comment-coordinate note) are already documented in the schema. The description only echoes region's purpose ('Pass region to read one area'), so the schema does the heavy lifting and the baseline of 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?

The description names a specific verb and resource ('Read a Whiteboard') and immediately defines the artifact type ('an Artifact made with spec bisque-canvas/v1'). It then enumerates exactly what comes back: frames, shapes with their text and containing frame, arrow connections, and an outline form. That is far more than a restatement of the name and clearly separates it from write-oriented siblings.

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?

It gives three concrete situations to use it ('before changing a board, to answer a comment about it, or to turn the board into a document or a presentation') and indicates region as the narrow-read option. It stops short of explicitly naming the alternative tool (edit_board) or stating when not to use it, but the context is clear enough for an agent to choose correctly.

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.

Resources