update_comment

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

No annotations provided, so the description carries full burden. 'Edit' implies mutation but doesn't disclose permissions needed, whether partial updates are supported, or what happens to unmentioned fields. No mention of thread behavior or comment-type restrictions.

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

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

A single short sentence is efficient, but it's under-specified rather than genuinely concise. With 4 parameters, no additional structure or param clarification is provided, so brevity comes at the cost of usefulness.

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

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 50% param coverage is under-specified. Does not clarify which comment types this applies to (task vs list vs threaded), whether it updates the comment text only or also status fields, or what the response looks like.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50% (comment_id and comment_text documented). The description adds minimal value beyond the schema. The 'assignee' and 'resolved' parameters are undocumented, and the description does nothing to clarify their meaning or relationship to editing a comment.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Clear verb+resource ('Edit an existing comment'). Distinguishes from create_task_comment/create_list_comment (creation) and delete_comment (deletion), though it doesn't explicitly name them. A bit generic but unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

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

No guidance on when to use this vs alternatives like create_task_comment or create_list_comment. Does not specify which comment types it edits (task, list, chat view). No context on prerequisites or when editing is appropriate.

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