Edit Jira Issue

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

It adds valuable operational context not in the schema or annotations, specifically noting that the 'Description' field supports markdown, which is a crucial execution detail.

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 definition is extremely concise, using two focused sentences to cover the purpose, key input format, and basic return structure.

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?

The description is highly complete for execution, particularly since it defines the return structure ('Returns {ok, key}') which is not fully specified in the schema.

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?

Although the schema is 100% covered, the description adds semantic meaning by clarifying the expected structure ('Pass fields as {fieldName: value}') and detailing the markdown capability of the description field.

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 explicitly states the function ('Update fields on a Jira issue') and is clearly distinguishable from sibling tools like 'createIssue' or 'getIssue' by focusing on the 'update' action.

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 implied usage by contrasting it with creation/retrieval, but it offers no specific guidelines regarding constraints or when it should be chosen over related complex Jira API calls.

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