Skip to main content
Glama

Read planning board

read_board
Read-only

Retrieve the exact saved board for a project, select a historical revision when needed, and pass a known cache revision only while its scene remains in context to skip unchanged scene payloads.

Instructions

Read the exact saved board. Reuse cacheRevision as knownRevision only while its scene is still in context; an unchanged response omits the scene. revision selects a historical board.

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
revisionNo
knownRevisionNo
workspacePathNoTrusted absolute project path from this chat; pass on every call. null selects personal storage. Omission uses only the environment default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare a safe read (readOnlyHint=true, destructiveHint=false, openWorldHint=false), yet the description still adds real behavior: an unchanged response omits the scene entirely, and revision switches the read to a historical snapshot. These are non-obvious response traits that would otherwise surprise the agent.

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 dense sentences, front-loaded with the core action and then the two operating rules. The word "cacheRevision" appears without ever being tied to a parameter or return field, which costs a little clarity for the brevity gained.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, and the description references a cacheRevision value the agent presumably receives from a prior response without saying so, leaving the caching loop partially unexplained. For a three-parameter tool with a stateful read protocol, this is adequate but incomplete.

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 only 33% (only workspacePath is documented), so the description must carry the load for knownRevision and revision. It does: knownRevision is a cache token reused only while the scene remains in context, and revision selects a historical board version. The lingering gap is that "cacheRevision" is named but never sourced.

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?

"Read the exact saved board" gives a specific verb and resource, and the phrase "exact saved" implicitly contrasts with the proposal-oriented siblings (read_board_proposal, propose_board). It stops short of naming an alternative outright, so an agent still has to infer the boundary.

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 description gives clear conditional guidance for parameters (reuse knownRevision only while the scene is still in context; revision for history), but there is no guidance on when to call this versus read_board_proposal, list_board_proposals, or read_project_document. Usage is implied rather than routed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.