Jira: Create Issue

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

No annotations. Description discloses API endpoint and support for ADF docs but no behavioral traits like rate limits, auth requirements, or side effects. Minimal transparency.

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?

Single sentence, front-loaded with action and endpoint. Concise but could be structured with separate sentences for required vs optional info.

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?

Missing output schema, no explanation of return values (e.g., issue key/ID). Does not elaborate on validateAdf or error handling. Adequate but incomplete for a complex creation tool.

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?

Adds meaning beyond schema by specifying required fields (project, issuetype) and custom field support, including ADF format. Schema already describes both parameters but this clarifies usage.

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?

Clearly states action (create) and resource (Jira issue). Mentions required fields (project, issuetype) and optional custom fields/ADF. However, does not distinguish from bulk creation or update siblings.

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 vs alternatives like bulk_create or update. No prerequisites or context provided. Only mentions which fields to supply.

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