Skip to main content
Glama
yenchieh

DiagramZu

by yenchieh
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

add_comment

Post a comment on a diagram, pin it to a specific node, or reply to a top-level thread to leave review findings for humans.

Instructions

Post a comment on a diagram. Pass nodeId to pin it to a specific node, or parentId to reply to an existing top-level comment (threads are one level deep). The author is the API token's owner. Use this to leave structured review findings a human will see on the diagram.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesComment text (1–5000 chars)
spaceNoWhich workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.
nodeIdNoPin to this node id (top-level comments only)
parentIdNoReply to this top-level comment id
diagramIdYesDiagram UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.0.7
    • addedInput schema / properties / space
      Added value: +{
+  "description": "Which workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.",
+  "type": "string"
+}
  2. Addedv0.0.4

TDQS

A4.2/5.0
Behavior4/5

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

No annotations, so the description carries full burden. It discloses that the author is the API token's owner, that threads are strictly one level deep, and that nodeId is only for top-level comments – key behavioral facts. It stops short of describing permissions needed, editability, or notification behavior, which keeps it from 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.

Conciseness5/5

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

Three tightly packed sentences, all front-loaded and zero waste. Every clause conveys necessary 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?

For a comment-creation tool with no output schema and no annotations, the description covers author attribution, threading depth, and node pinning rules. It omits return value details (expected, as no output schema), and doesn't mention rate limits or whether comments are editable, but those are minor against the core operation.

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 100%, so every parameter is already documented in the schema. The description reinforces nodeId/parentId semantics and the threading constraint but adds no syntax, format, or validation details beyond what the schema says. Baseline 3 is appropriate.

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?

Specific verb+resource ('Post a comment on a diagram') and distinguishes itself from siblings by naming the pinning and threading capabilities. An agent can pick this apart from list_comments without opening the 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?

The description gives clear context for when to use each parameter combination ('Pass nodeId to pin...', 'parentId to reply...') and states the intended context ('structured review findings a human will see'). It doesn't mention alternatives like list_comments or when not to comment, but the usage context is clear.

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

Deploy Server

Other Tools