update_test_records

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

Annotations already indicate destructive and idempotent hints. The description adds atomicity (one bad item rejects whole batch), validation requirements, comment_format being stored as text/html, and dry_run behavior. No contradictions.

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?

Concise, front-loaded paragraph with clear sentences. Every sentence adds value: purpose, guidelines, constraints, return info.

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 4 parameters (including array with subfields), annotations, and output schema, the description thoroughly covers operation, batch size, atomicity, parameter constraints, return value, storage behavior, and validation.

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 100% and good schema descriptions. Description adds extra context: record_id must be copied verbatim, comment sent verbatim, result must be run-valid, defect_id must exist, comment_format ignored.

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 states a specific verb and resource: 'Set result, comment, and/or defect link on 1-50 test records of one test run in a single bulk PATCH.' It distinguishes from the sibling 'update_test_runs' for run-level fields.

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 tells when to use (batch test record updates) and when not (run-level fields, use update_test_runs). Provides constraints: record_id verbatim, result must be valid, defect_id must exist, atomicity, and advice to re-read via list_test_records.

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