create_test_records

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

Annotations give minimal safety hints, but the description adds critical behavioral context: atomicity, duplicate iteration semantics, verbatim comment handling, full id returns, and validation rules that go far beyond the annotations.

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 dense but every sentence contributes important information. The purpose is front-loaded, though the overall structure is a single paragraph that could be better organized into bullet points for readability.

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?

The tool is complex (batch atomic creation, validations, duplicate semantics) and the description covers all key aspects, including return IDs and validation rules. It is complete even with an output schema available.

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?

Since schema description coverage is 100%, baseline is 3. The description adds meaningful semantics beyond the schema, such as validation of result, that defect must reference an existing work item, and that comment_format controls verbatim sending.

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 it creates 1-50 test records on one test run, with a specific verb and resource. It also distinguishes from sibling tools by naming create_test_runs and list_test_records.

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?

Provides explicit guidance: use list_test_records for reading back, create_test_runs for creating the run, and resolve invalid test_case_id via list_work_items. It also explains batch behavior and duplicate handling.

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