Read a Whiteboard
read_boardRead 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
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | Board coordinates of an area, as a comment pinned to a region carries them; only what overlaps it is returned. | |
| artifact_id | Yes | The Artifact id (art_…): the last part of its link, as in bisque.cloud/documents/art_…, /pages/art_… or /artifacts/art_…. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| frames | Yes | ||
| shapes | Yes | ||
| outline | Yes | ||
| truncated | Yes | ||
| artifact_id | Yes |