Skip to main content
Glama

whiteboard_rename

Idempotent

Rename a specified board by ID, passing expectedVersion from inspect to prevent overwriting newer edits.

Instructions

Rename an explicit board. Supply expectedVersion from inspect for conflict protection. 重命名明确指定的白板;支持版本校验。

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": {
      "boardId": "<boardId>",
      "title": "<title>"
    },
    "name": "whiteboard_rename"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYes
boardIdYes
expectedVersionNo

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.7/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, and readOnlyHint=false, consistent with a rename. The description adds genuine behavioral context beyond them: optimistic concurrency control via expectedVersion prevents overwriting concurrent edits, which the annotations do not convey. It does not state what happens on a version conflict, keeping it short of a 5.

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 core content is front-loaded and tight, but the sentence pair is duplicated verbatim in Chinese, adding length without adding information. The English alone would be a 4.

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?

An output schema exists so return values need no explanation, and annotations carry the safety profile. Still missing for a mutation tool: conflict-failure behavior and whether title must be unique among boards, which an agent would want before calling.

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 description coverage is 0%, so the description must compensate. It explains expectedVersion's source (inspect) and purpose (conflict protection), but leaves boardId format and title constraints (1–120 chars, uniqueness) undocumented beyond what the field names imply.

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+resource ("Rename an explicit board"), which cleanly separates it from sibling mutators like whiteboard_update_elements or whiteboard_native_edit that change content rather than metadata. It does not explicitly name a sibling to defer to, but the operation is unambiguous.

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?

"Supply expectedVersion from inspect" gives concrete guidance on how to obtain the optional parameter and why (conflict protection), effectively routing the agent to the whiteboard_inspect sibling. There is no explicit when-not guidance, but for a simple rename the context is sufficient.

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