Zephyr: Create Test Case

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

Annotations already communicate that this is a mutating, non-idempotent action. The description adds some behavioral context, such as the expected output (newly created Test Case with details and key) and customFields formatting rules, but does not go further into auth needs, side effects, or error conditions. This is adequate but not rich.

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?

The first sentence is front-loaded and the examples are genuinely useful. However, the description repeats the full parameter list that the schema already documents, making it longer than necessary. The structure is organized, but the redundancy prevents it from being concise.

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 tool with 12 parameters and nested customFields, the examples cover several important usage patterns and the output schema covers return values. Still, the invalid ownerJiraUserId example and the estimatedTime type mismatch leave enough ambiguity that an agent could build a failing request. The description is mostly complete but not fully reliable.

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 high at 92%, so the parameter list in the description adds little beyond the schema; the examples do add useful mapping from natural-language requests to parameters. However, Example 4 uses 'ownerJiraUserId', which is not in the schema (and the schema sets additionalProperties to false), and gives a numeric value where ownerId expects a string. Also, estimatedTime is described as a number while the schema declares integer. These inconsistencies actively risk misleading an agent.

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 first sentence states a clear verb and resource: 'Create a new Test Case in Zephyr specified project.' This distinguishes it from the many sibling create/update test case tools by naming both the toolset and the product, and from zephyr_create_test_case_steps which is for adding steps rather than creating the test case itself.

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 description clearly states what this tool is for: creating a test case in a Zephyr project, with projectKey and name as the required inputs. It does not explicitly say when not to use it or name alternatives, but the purpose is explicit enough that an agent can infer it should be chosen over update/delete/step-creation siblings.

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