Update Test Manager Test Case

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

Despite no annotations, the description discloses key behaviors: attachments replace the whole list while omitted leaves existing untouched; new_steps are appended only; internally fetches snapshot_id; requires at least one change. 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?

Every sentence adds value, no redundancy. Front-loaded with main action, then specifics. Efficiently covers constraints and behaviors.

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 12 parameters, no schema coverage, no output schema, and no annotations, the description is thorough. It explains replace vs merge, append-only steps, snapshot fetch, and constraints. No obvious gaps for agent decision-making.

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%, requiring description to compensate. It explains most parameters (title, description, priority, etc.) and details attachment replacement and step append behavior. Missing explanation for commit_message, but overall adds significant meaning beyond 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 it updates metadata (listing fields) and/or appends new steps. This distinguishes it from siblings like tm.update_testCaseInstance which update instance steps, and tm.update_testCaseInstanceStep which modifies existing steps in an instance.

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 states when to use (update metadata or append steps), what not to do (cannot modify/delete existing steps, BDD, dynamic fields), and warns against speculative calls. Also mentions prerequisite to use tm.upload_attachment for file keys.

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