create_test_case

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

With no annotations, the description carries the full burden of behavioral disclosure. It reveals naming conventions (suite_path must start with 'suite_', test_case_name prefixed with 'tst_'), optional behavior (test_content default empty, is_bdd flag toggles BDD structure), and specific QtCare Squish BDD structure. It does not mention side effects like file creation, permissions, or error handling, but the core behavior is well-covered.

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 concise and structured. The first sentence states the main purpose, followed by a clear Args block that is easy to scan. No unnecessary words; every sentence earns its place. It is front-loaded with the core action.

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 tool has 5 parameters (2 required) and no annotations, the description covers all parameters and their behaviors, including naming conventions and optionality. It does not describe the output (though output schema exists) or error conditions, but for a creation tool, it provides sufficient context to use correctly.

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%, so the description must compensate, and it does excellently. Each parameter is explained with constraints and defaults: suite_path absolute and must start with 'suite_', test_case_name prefixed, test_content optional Python code, is_bdd default false, test_description for BDD. This adds significant meaning beyond the bare 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 specifies the action ('Create a new Squish test case') and the resource ('within an existing test suite'). It distinguishes from sibling tools like 'create_test_suite' (creates suite, not case) and 'generate_test_template' (generates template, not directly creates). The verb 'create' is specific and the target is well-defined.

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 implies usage context by requiring an existing test suite suite_path, but does not explicitly state when to use this tool versus alternatives like 'create_test_suite' or 'generate_bdd_template'. It provides clear prerequisites (suite_path must exist, naming conventions) but lacks explicit 'when to use' and 'when not to use' guidance.

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