Toggle comment reaction

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

Annotations already mark readOnlyHint=false, destructiveHint=false, and idempotentHint=false. The description goes far beyond that by explaining the toggle semantics (double-invocation leaves state unchanged), authentication ownership rules, the 400 rejection for journal entries, version requirements, and the 404/version-hint behavior. This is rich behavioral detail that helps the agent anticipate failures.

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?

The description is detailed but tightly organized: purpose, usage guidance, pitfalls, and cross-references. Every sentence carries operational value. While long, it is appropriately structured with clear sections and bolded pitfalls, and it front-loads the core purpose before diving into edge cases.

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?

Given the tool's toggle behavior, auth constraints, version dependency, and error modes, the description covers all these aspects comprehensively. It explains return state, references the output schema implicitly, and cross-links to the exact sources for the required activity_id. Nothing essential is left unstated.

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 100%, but the description adds crucial meaning: activity_id is 'an activity id, not a work package id' and comes from specific sibling tools, while reaction names must be used because 'Passing the emoji character itself is rejected.' These details prevent common invocation mistakes and exceed what the schema alone provides.

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?

The description opens with a specific verb and resource: 'React to a work-package comment with an emoji, or take your reaction back.' It clearly distinguishes this toggle from sibling tools like add_work_package_comment and edit_work_package_comment, and reinforces that with explicit cross-references.

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?

It provides explicit use-case guidance: 'Use this for the lightweight acknowledgement a comment does not deserve' and names alternatives: 'list_work_package_comments reads the thread and produces activity ids; add_work_package_comment says something in words when an emoji is not enough.' It also warns against blind retries, which is a key when-not-to-use pointer.

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