update_issue

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

No annotations; description only states 'update' without disclosing side effects, permissions, concurrency behavior (though version param hints at optimistic locking, not explained), or partial vs full 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?

One short sentence; very concise but at the cost of completeness. No structure or additional 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?

For a 9-parameter mutation tool with no output schema or annotations, the description is insufficient. Missing details on return value, concurrency, and permissions.

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 44%; description adds 'status, assignee, description, etc.' but does not clarify parameters missing schema descriptions (subject, priority, severity, tags). Minimal value beyond schema.

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 clearly states the tool updates an existing issue and lists example fields like status, assignee, description. It distinguishes from create, get, and delete operations. However, 'etc.' is vague.

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 tool vs alternatives (e.g., create_issue, get_issue). No mention of prerequisites or contexts.

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