Skip to main content
Glama
yenchieh

DiagramZu

by yenchieh
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_comments

Retrieve comments on a diagram, oldest first, with author, resolved state, body snippet, and pinned node. Filter by nodeId to view only one node's thread.

Instructions

List comments on a diagram, oldest first. Returns id, parentId (null for a top-level comment), nodeId (the pinned node, if any), author, resolved state, and a body snippet. Use nodeId to fetch only the thread pinned to one node.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax items (default 500, max 500)
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.
nodeIdNoOnly comments pinned to this node id
offsetNoItems to skip (default 0)
diagramIdYesDiagram UUID
includeResolvedNoInclude resolved threads (default true)

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

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries full behavioral disclosure burden. It usefully enumerates return fields (id, parentId, nodeId, author, resolved state, body snippet) and ordering, but omits read-only nature, required permissions, rate limits, and pagination behavior, leaving significant gaps.

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 sentences with no filler, front-loading purpose, then return shape, then a usage tip. Efficient, though slightly less crisp than the ideal two-sentence structure.

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's explicit return-field list is valuable. The schema fully covers parameters, and the description adds ordering and nodeId usage. Some behavioral context (e.g., default pagination, space parameter implications) is missing, but the definition is adequate for a list tool.

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 the schema already documents all six parameters thoroughly. The description adds only a minor rephrasing for nodeId and provides no additional semantic detail for other parameters, matching the baseline for high-coverage schemas.

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 and resource ('List comments on a diagram') plus an ordering guarantee ('oldest first'). However, it does not differentiate itself from sibling tools like add_comment or other list_* tools, so it falls short of a 5.

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?

Provides a specific usage instruction for the nodeId filter ('Use nodeId to fetch only the thread pinned to one node'), which is helpful. But it offers no guidance on when to use this tool versus alternatives (e.g., add_comment) or when not to use it, leaving usage implied.

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