Skip to main content
Glama

Read a board

read_board
Read-only

Read a board: its kind and current content (the Markdown or HTML text, or the doodle's elements with their ids, roles, boxes and styles).

Input Schema

NameRequiredDescriptionDefault
boardYesThe board's 22-character code, or its URL

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

readOnlyHint=true already declares the safety profile, so the description's job is to add context — and it does, by disclosing the shape of the returned content per board kind, which matters since there is no output schema. It omits error behavior for an invalid board code and any truncation/size limits.

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?

One front-loaded sentence that leads with the verb and resource, with the return-shape detail packed into a parenthetical. The parenthetical is dense but every clause carries information; nothing is wasted.

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 one-parameter read tool with annotations and no output schema, the description covers the main unknown — what the response contains for each board kind — which is exactly what the missing output schema would have provided. Only failure modes for bad board identifiers are unaddressed.

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 single 'board' parameter is fully documented in the schema (100% coverage) including that it accepts a 22-character code or a URL. The description adds nothing about the parameter, so the schema does all the work and the baseline of 3 applies.

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?

States a specific verb (read) and resource (board), and enumerates what content comes back: Markdown/HTML text or doodle elements with ids, roles, boxes and styles. It does not differentiate itself from the sibling open_board, which an agent could easily confuse with reading a board's content, so it falls short of a 5.

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

Usage Guidelines2/5

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

There is no statement of when to use this versus open_board, draw, edit_text or write_board, and no prerequisites or exclusions. Usage is only inferred from the verb 'read' and the word 'current content'.

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