Skip to main content
Glama

get_whiteboard

Read-onlyIdempotent

Read a whiteboard as a compact text representation: board bounds plus one line per element — " at , size x [color] [parent ] [linked <card|epic> ] "text"", connectors as "connector -> ". Element uids from here are the handles every whiteboard write tool takes. Requires a Pro or trial workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe unique identifier of the whiteboard

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, covering safety. The description adds the return format (compact text representation with board bounds and per-element lines) and the auth requirement, which enriches beyond the annotations. No contradiction.

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?

The description is detailed but efficiently organized: purpose, output format with examples, usage note, and requirement. Each sentence contributes value; the format example is clear and compact. It's slightly long but justified given the need to specify the exact text representation.

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?

With no output schema, the description fully specifies the return format, including the exact line structure for elements and connectors, and the significance of uids. It also covers the auth requirement. For a read tool with one parameter, nothing essential is missing.

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% for the single 'id' parameter, which the schema already describes as 'The unique identifier of the whiteboard'. The description does not add any extra semantic details about the parameter itself (e.g., format or source), so it meets the baseline but doesn't exceed it.

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 opens with a clear verb+resource ('Read a whiteboard') and immediately specifies the output format, distinguishing it from sibling tools like list_whiteboards (which lists boards) and write tools (create/update). The detailed format example leaves no ambiguity about what this tool does.

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 implicitly routes usage by noting that element uids from this read are the handles for every whiteboard write tool, suggesting when to call this (before writes). It also states the Pro/trial requirement. However, it doesn't explicitly contrast with list_whiteboards or state when not to use it, so it's not fully explicit.

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