jira_tasks_cancel

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

Annotations only include readOnlyHint=false; description adds behavioral context: that the tool requests cancellation (mutation), and returns a specific structure. It also notes the limitation on bulk-queue tasks, which is beyond annotations.

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?

Three concise lines: purpose, applicability, and return format. No unnecessary words; front-loaded with essential information.

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?

For a simple cancel tool, the description covers purpose, usage constraints, parameter context, and return format. Given the availability of output schema and clear schema, it is complete.

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 has 100% coverage with a single parameter (task_id) already described. Description does not add additional parameter semantics but reinforces the parameter's role by noting the '/task/{id}' path.

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?

Description clearly states the tool cancels a running generic async task, with specific verb and resource. It also adds the nuance that only /task/{id} tasks that are cancellable are applicable, distinguishing it from potential other cancel mechanisms.

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?

Explicitly states when to use (cancellable /task/{id} tasks) and when not to use (bulk-queue tasks cannot be cancelled this way). Provides clear context and limitations.

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