Skip to main content
Glama

read_board

Read-only

Read a shared Excalidraw board and open it. Returns its shapes and the URL where anyone can watch and edit it live. Leave out board to start a new one.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
boardNoThe board's id, as in its URL.

Output Schema

NameRequiredDescriptionDefault
urlYes
boardYesThe board's id, as in its URL.
shapesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses what comes back ("its shapes") and a notable access-control property: the returned URL lets "anyone" watch and edit live, which is critical context an agent would not get from the schema. The phrase "start a new one" slightly muddies the read-only framing by implying creation of a board, but it reads as an ephemeral/open-a-blank-board behavior rather than a mutation of existing data.

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?

Three short sentences, front-loaded with the purpose, then the return behavior, then the parameter edge case. Nothing is bloated, though "read ... and open it" is mildly redundant and could be tightened.

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 a single-optional-parameter read tool with an output schema, the description covers purpose, return shape, sharing semantics, and the default behavior well enough to call correctly. Only the relationship to sibling tools (e.g., sync, get_image) is left unaddressed.

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% and the schema already explains the id format, so the baseline is 3. The description earns an extra point by documenting the consequence of omission (a new board is started), which the optional-parameter schema does not convey.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb and resource ("Read a shared Excalidraw board") and states the effect ("open it"), which is far more than restating the name. It does not, however, distinguish itself from siblings like get_image or sync, so the agent must still infer why this differs from other read-ish operations.

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

Usage Guidelines3/5

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

The one piece of routing guidance given is "Leave out board to start a new one," which tells the agent what omitting the optional parameter does. There is no explicit when-to-use versus when-not guidance and no mention of the sibling tools, so usage is only implied.

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.