Skip to main content
Glama

读取白板

whiteboard_inspect
Read-only

Inspect whiteboard pages, element IDs, text, bounds, styles, and version before and after editing to retrieve accurate IDs and verify changes.

Instructions

Inspect pages, element IDs, text, bounds, styles, version, and agent context. Read before and after editing. The default board is the most recently updated, not necessarily the board open in the UI. 读取页面、元素 ID、位置、尺寸、颜色和文本。修改前先调用此工具取得准确 ID。

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": "whiteboard_inspect"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
pageIdNo仅检查指定页面
boardIdNo白板 ID;省略时使用最近更新的白板,建议始终指定准确 IDdefault

Output Schema

NameRequiredDescriptionDefault
boardNo
errorNo
boardsNo
pageIdNo
boardIdNo
currentNo
deletedNo
versionNo
alignedIdsNo
deletedIdsNo
elementIdsNo
updatedIdsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.7

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds a genuinely non-obvious behavioral caveat: the default board is the most recently updated, not the one open in the UI. That is real value beyond structured fields, though no mention of pagination behavior for the limit.

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

Conciseness3/5

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

The English portion is tight and front-loaded, but the Chinese sentence largely duplicates 'read before and after editing' and the ID purpose already stated in English. The bilingual restatement costs space without adding information.

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?

An output schema exists, so return shape need not be described, and annotations cover safety. The description supplies the remaining critical context — when to call it and the default-board pitfall — leaving only minor gaps such as limit/pagination behavior.

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 67%; pageId and boardId are documented in the schema, while limit (default 200, max 1000) is undocumented anywhere. The description's default-board note reinforces the boardId semantics already present in the schema rather than adding new parameter detail, so baseline 3 fits.

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 (inspect/read) and enumerates the concrete resources returned: pages, element IDs, text, bounds, styles, version, agent context. This clearly distinguishes it from whiteboard_list or whiteboard_get_thumbnail, though it never names those siblings explicitly.

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?

Gives explicit timing guidance — 'Read before and after editing' and the Chinese '修改前先调用此工具取得准确 ID' — so the agent knows this is the prerequisite for the edit tools. It stops short of naming which sibling to use for listing boards or fetching thumbnails.

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