updateCase

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

Discloses that it updates existing case and only specified fields. With no annotations, description carries full burden but does not mention permissions, error handling, or return value. Adequate but not thorough.

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?

Front-loaded with purpose. Explains required/optional, then key notes. Could be slightly more concise but well-structured overall.

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?

Covers main points but lacks details on return value, error cases, and some parameters (refs, estimate, milestoneId). The 'etc.' is vague. For 13 params with no output schema, it is moderately complete.

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%, baseline 3. Description adds value by explaining relationships (e.g., templateId=2 required for customStepsSeparated, alternative for simple steps, customFields usage). Provides examples and clarifies grouping.

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?

Clearly states 'Updates an existing test case' with specific verb and resource. Lists required and optional parameters, and distinguishes from siblings like addCase, deleteCase, and updateCases.

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?

States required parameter caseId and that only specified fields are updated. Provides note about templateId=2 and alternative for text steps. However, lacks explicit comparison to updateCases (plural) and does not mention when not to use this tool.

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