Skip to main content
Glama
Sign In

Onplana

by io.github.Onplana
OverviewDiscussionsAdmin

get_whiteboard

Read-onlyIdempotent

Get a whiteboard incl. Excalidraw elements (array) + appState. Use update_whiteboard with elements to commit changes; version bumps on each write. Plan gate: whiteboards (PRO+).

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": {
      "whiteboardId": "<whiteboardId>"
    },
    "name": "get_whiteboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
whiteboardIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is low, yet the description adds real context: the plan gate ('whiteboards (PRO+)') and the versioning behavior ('version bumps on each write'). These are useful auth and concurrency facts not present in the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three compact clauses, front-loaded with the return payload, then the write-path pointer, then the access constraint. No sentence is padding.

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?

No output schema exists, so the description carries the return-value burden and does so by naming elements and appState. It also flags the plan requirement. The only missing piece is guidance on obtaining whiteboardId.

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 0% for the single whiteboardId parameter, and the description never says where the ID comes from (e.g., list_whiteboards) or its format. With a lone, name-obvious parameter the gap is minor, but the description adds no meaning beyond the schema field name.

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?

States a specific verb (Get) and resource (whiteboard) plus the exact return payload (Excalidraw elements array + appState). An agent can separate it from list_whiteboards (discovery) and update_whiteboard (mutation) without opening any schema.

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?

Explicitly routes the write path: 'Use update_whiteboard with elements to commit changes,' which clarifies this tool is read-only. It does not, however, say when to use this vs. list_whiteboards for discovering IDs, so one alternative is left implicit.

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

All Onplana toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources