update_comment

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

Discloses partial update behavior and that it returns the updated comment. No annotations provided, so description carries full burden. Lacks mention of permissions or error conditions, but sufficient for a simple update.

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?

Two sentences, no fluff. Front-loaded with the core action and fields, followed by essential behavioral and scope details.

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?

Covers key aspects: what it updates, partial update, return value, and supported comment types. No output schema, but description mentions return. Lacks clarification on assignee format or error handling, but adequate.

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 already describes all parameters (100% coverage). Description adds value by emphasizing partial update behavior, which is not explicit in schema. Minor addition but helpful.

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?

Explicitly states it edits an existing comment with specific actions (change text, reassign, resolve/unresolve). Clearly distinguishes from create/delete sibling tools by focusing on updating.

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?

Provides partial update guidance ('Only the fields you provide are changed') and specifies compatibility with task, List, and Chat-view comments. Does not explicitly mention when not to use, but alternatives are clear from context.

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