Skip to main content
Glama

add_comment

Use this to add a comment to a specific task. Provide board_id + task_number to identify the task.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYesComment text.
board_idYesBoard ID where the task belongs.
task_numberYesTask number in board scope.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/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, yet it discloses almost no behavior: no mention of required permissions, whether the comment notifies task watchers, whether it is editable afterward, or what the response contains. For a mutation tool with zero annotation coverage, this is a significant gap.

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?

Two short sentences, front-loaded with the action and followed by the identifying inputs. The second sentence is largely redundant with the schema's parameter descriptions, but there is no padding or filler.

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?

A mutation tool with no annotations, no output schema, and no explanation of permissions, side effects, or return value. An agent can call it, but cannot predict its effects or failure modes from the definition alone.

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 all three parameters (text, board_id, task_number) are already documented in the schema. The description's restatement of 'board_id + task_number to identify the task' adds no syntax or constraint detail beyond that baseline.

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: 'add a comment to a specific task.' This is unambiguous and distinguishable from the siblings list_comments and delete_comment, though the description never names or contrasts 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 Guidelines2/5

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

The description says nothing about when to use this versus alternatives (e.g., update_task for editing, list_comments for reading) or any preconditions. It only explains how to identify the target task, which is identification guidance rather than usage guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources