build_jira_automation

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

Discloses that it creates multiple artifacts and skips non-automated steps. However, with no annotations provided, it does not cover side effects, idempotency, or error handling, which would enhance 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?

Four sentences, each adding essential information: purpose, components, exception, and prerequisite. No filler or redundancy.

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?

Adequately covers the tool's operation and prerequisites, but omits details about return values, error handling, or success criteria. Given the absence of an output schema, this is a minor gap.

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?

The input schema provides 100% coverage with descriptions for all four parameters. The tool description adds context by explaining that the flow operates on the specified sn_table and that field_mappings are overrides, which adds value beyond the 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 builds ServiceNow Flow Designer artifacts for a Jira Automation rule, listing specific components (flow record, trigger, condition blocks, action steps). It distinguishes from siblings like analyze_jira_automation by establishing a clear prerequisite.

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?

Explicitly states the prerequisite: 'Only call this after analyze_jira_automation and user confirmation.' Also notes that steps that cannot be automated are skipped, guiding the user to the manual build guide for those steps.

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