create_test_record_attachments

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

The description discloses non-obvious behaviors not fully covered by annotations: server reads file_path locally requiring absolute paths, 25 MiB cap per call, server-assigned attachment_ids differing from file_name, whole-batch rejection on collision, and explicit non-idempotency. This aligns with annotations (idempotentHint=false, readOnlyHint=false) with 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?

The description is detailed but every sentence serves a purpose: core action, alternatives, prerequisites, file_path caveat, size limits, output naming, collision behavior, and idempotency. It is front-loaded and structured logically, with no wasted words.

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 complex upload operation with 6 parameters, the description covers all essential aspects: purpose, alternatives, prerequisites, operational constraints, error conditions, and idempotency. An output schema exists, so return values are not required in the description.

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 100%, so baseline is 3. The description adds critical semantics beyond the schema: file_path must be absolute and server-readable, file_name is not the id, iteration matches get_test_record, and collision behavior with existing attachments. This meaningfully enhances agent understanding.

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 ('Upload'), resource ('test record attachments'), and scope ('1-10 local files in one request'). It explicitly distinguishes from sibling tools by directing document attachments to create_document_attachments and work item attachments to create_work_item_attachments.

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 when-to-use guidance: names alternatives and when to use them. Also instructs to verify record coordinates via list_test_records first and advises on handling size caps (split batches) and name collisions (check list_test_record_attachments).

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