Skip to main content
Glama

add_comment

Attach a comment to a board or a specific element by providing its path, enabling targeted feedback directly on the design canvas.

Instructions

Add a comment to a board, or to an element inside it when path is given.

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": {
      "file": "<file>",
      "text": "<text>"
    },
    "name": "add_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileYes
pathNo
textYes
authorNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It implies a mutation but does not state permission requirements, whether the comment is visible to other users, whether it can be edited or deleted afterward, or what identifier is returned.

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?

One compact sentence that front-loads the action and its target. It is not padded, though its brevity comes partly at the cost of the missing behavioral detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations, no output schema, and 0% parameter description coverage, the definition does too little. An agent lacks any return-value or side-effect information needed to call it confidently.

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 what 'path' does and implies that 'file' is the board target, but leaves 'text' and especially the optional 'author' (who authors the comment if omitted?) undocumented.

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?

Uses a specific verb and resource ('Add a comment') and clarifies that the target can be either a board or an element within it. It implicitly distinguishes itself from reply_comment and list_comments, but does not name 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 Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives one conditional usage rule: when path is given, the comment attaches to an element inside the board. It does not say when to use this instead of reply_comment, nor does it cover prerequisites such as requiring an existing board or open session.

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