convert_to_jira

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

Annotations indicate idempotent=true and readOnly=false; the description adds valuable behavioral context that the tool conditionally writes files to disk when output_path is provided, versus returning content directly, and details the exact transformation logic for content conversion.

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?

Two well-structured sentences front-load the core purpose first, followed by specific syntax transformations. Efficient length with minimal redundancy, though the second sentence is dense with multiple examples.

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 2-parameter conversion utility with good annotations and no output schema, the description adequately covers transformation behavior, dual output modes, and input expectations. Could benefit from mentioning error handling or character encoding.

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?

With 100% schema coverage, the baseline is met, but the description adds meaningful context about supported Markdown syntax (tables, task lists) that clarifies valid input for the 'markdown' parameter beyond the schema's technical description.

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 'Convert Markdown to JIRA wiki markup' with specific verb and resource. The detailed syntax examples (h1./h2., {code} blocks, [text|url] links) explicitly distinguish this from sibling converters like convert_to_confluence or convert_to_bbcode.

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?

The specificity of 'JIRA wiki markup' provides implicit guidance for when to use this tool versus the 20+ other conversion siblings, but lacks explicit when-to-use guidance or comparisons like 'use when targeting Atlassian JIRA vs other wiki formats'.

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