create_test_case

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

No annotations are provided, so the description carries the full burden. It discloses that steps are created after the test case, that projectId defaults to an environment variable, and how custom fields and steps are structured. This is good for a creation tool, though it could mention retention policies or error handling.

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 description is a single, dense paragraph of 156 words. It front-loads the purpose but mixes field details without clear structure (e.g., bullets). While every sentence adds value, it could be more concise and better organized for quick scanning.

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?

Given the complexity of the payload (nested object, multiple subfields) and lack of output schema, the description covers most input fields but omits other possible properties (e.g., tags, attachments) and does not describe the return value (e.g., created test case ID). This leaves some gaps for an agent.

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 0% (only payload object without inner properties), but the description compensates fully. It explains each subfield: projectId defaults, precondition vs description distinction, customFields format, and steps array structure with expectedResult guidelines. This adds immense 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 'Create a new test case.' It explicitly identifies the verb (create) and resource (test case), distinguishing it from siblings like 'update_test_case' or 'create_shared_step'. The detailed field guidance reinforces the purpose.

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 provides thorough usage instructions for each field (e.g., payload.precondition vs payload.description, step expectedResult formatting). It explains defaults and format requirements. However, it does not explicitly tell when NOT to use this tool or mention alternatives like 'update_test_case' for modifications.

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