Skip to main content
Glama

comment

Add a markdown progress note to a task to record updates, decisions, or status for other agents and humans.

Instructions

Add a markdown progress note to a task.

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": {
      "id": "<id>",
      "text": "<text>"
    },
    "name": "comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
textYes

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 supplied, so the description carries the entire behavioral burden. It implies a write/append operation but does not state whether the note is appended to existing notes or replaces them, whether it notifies anyone or requires specific permissions, what the response looks like, or whether the action is reversible. For an unannotated mutation tool 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?

A single front-loaded sentence with no filler. It is efficient, though its brevity is part of why other dimensions are under-specified.

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 simple two-required-parameter mutation with no annotations and no output schema, the description still leaves out what happens on success, how the note relates to existing task data, and any permission or visibility expectations. Given zero structured behavioral context, this is too thin.

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 0%, so the description must compensate. It does partially: "to a task" implies id is a task identifier, and "markdown" tells the agent the text should be markdown-formatted content. It adds no guidance on id format or whether text is required to be non-empty, so compensation is incomplete.

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: "Add a markdown progress note to a task." The markdown qualifier distinguishes this from a generic task update, so an agent can tell it is a commentary/notes operation rather than a field mutation like save_task. It does not explicitly differentiate against siblings such as link or inbox, which keeps it at 4.

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 gives no when-to-use context, no prerequisites (e.g., does the task need to exist or be assigned?), and no pointer to alternatives for other kinds of task updates. The only usage signal is implicit in the word "note."

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