Skip to main content
Glama

add_comment

Adds a Markdown-supported comment to a Kanboard task to log progress or share updates.

Instructions

Add a comment (Markdown supported) to a task, e.g. a progress log entry.

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": {
      "task_id": "<task_id>",
      "content": "<content>"
    },
    "name": "add_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYes
task_idYesKanboard task ID

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior3/5

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

The annotations already declare this is a non-destructive write (readOnlyHint=false, destructiveHint=false), so the description is not required to restate that. It adds real value by disclosing that comment content is parsed as Markdown, but says nothing about permissions, whether the comment can later be edited or removed, or side effects such as notifications.

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?

A single short sentence with the action front-loaded and no filler. The only slight inefficiency is that the example use case and the Markdown note share one parenthetical rather than being given distinct emphasis.

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?

For a simple two-parameter write tool with an output schema and safety annotations, most essentials are covered. However, nothing is said about required task access or what the call does when the task is closed or missing, which are the main open questions for a commenting 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 coverage is only 50%: task_id is documented in the schema, while content is only constrained to a non-empty string. The description compensates partially by clarifying that content is Markdown, which the schema does not state, but it does not describe content length limits or formatting expectations.

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?

The description gives a specific verb and resource ('Add a comment ... to a task') and adds a useful detail that Markdown is supported. It does not explicitly contrast with siblings, but no sibling in the list appears to handle comments, so an agent can still route correctly.

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?

Usage is only implied through the example 'e.g. a progress log entry', which suggests a logging/annotation use case. There is no explicit when-to-use or when-not-to-use guidance, and no mention of prerequisites such as the caller needing access to the task.

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