Skip to main content
Glama

edit_task_comment

Idempotent

Replace the text of a task comment using its task ID and comment ID to update existing content.

Instructions

Replace the text of one of my task comments (ids from get_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": {
      "task_id": "<task_id>",
      "comment_id": "<comment_id>",
      "text": "<text>"
    },
    "name": "edit_task_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes
task_idYes
comment_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is carried by structured data. The description is consistent with them ('Replace' = mutation, repeatable = idempotent) and adds the id-provenance hint, but it never says whether the original text is lost or recoverable, or whether the edit notifies anyone. With annotations in place, a 3 is appropriate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence with the action front-loaded and no filler; the id-source hint is folded into a parenthetical rather than given its own sentence. Nothing could be removed without losing information.

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?

An output schema exists and annotations cover the safety semantics, so the description only needs to frame purpose and identifiers, which it does. The remaining gap is minor: it doesn't say whether the edit overwrites wholesale or how failures (comment not found, not the author) are surfaced.

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 carry the burden for three required params. It does partially: it identifies that ids come from get_task and that 'text' is the replacement content, mapping to all three names. It gives no format, length, or validation details, and pointing comment ids at get_task rather than a comment-listing tool is a slightly loose hint.

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 ('Replace') and a specific resource ('the text of one of my task comments'), which cleanly separates it from add_task_comment and delete_task_comment in the sibling list. It doesn't explicitly name those siblings, so it stops short of a 5, but the operation is unambiguous.

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 word 'Replace' and the parenthetical '(ids from get_task)' imply the context of use: modifying an existing comment whose identifiers the caller already holds. There is no explicit when-not guidance (e.g. use add_task_comment to create, delete_task_comment to remove) and no stated prerequisites such as ownership.

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