jira_workflows_publish_scheme_draft

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

Annotations only set readOnlyHint=false, so description adds that publishing makes changes live. Also discloses that removing statuses requires mappings. No contradictions, but could mention more about permissions or side effects.

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 sentences: main action, condition, return format. No wasted words. Front-loaded with verb.

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?

Covers the essential: action, conditional param, validation mode, and return structure. Output schema exists, so return field details not needed. Complete for agent decision-making.

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?

All 3 parameters are documented in schema (100% coverage). Description adds context: explains why status_mappings is needed (relocate issues) and that validate_only returns validation. Example in schema is helpful.

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?

Clear verb+resource: 'Publish a workflow scheme draft, making its changes live.' Distinguishes from sibling tools like jira_workflows_create_scheme_draft. Also mentions return shape.

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?

States when to use (publish a draft) and condition requiring status_mappings. Implicitly distinguishes from other workflow tools, but lacks explicit when-not-to-use or alternatives.

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