get_test_case

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

With no annotations, the description discloses the fallback behavior (resolves by key via search) and the versionNo switch. This adds meaningful behavioral context beyond what the schema provides.

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?

Two sentences, front-loaded with the action, no wasted words. Every part is informative and earns its place.

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 simple GET tool, the description covers the fallback logic and mode switch. No output schema exists, but the description sufficiently sets expectations for the response (slim record or version details).

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). The description adds meaning: testCaseId can be internal id or key, and versionNo returns version details instead of slim record. This enhances parameter 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 clearly states the tool fetches a test case by ID, with fallback to key search. It distinguishes from siblings like 'search_test_case' by specifying the direct lookup and optional version detail mode.

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?

The description implies use when you have an ID or key and want a single test case, optionally with version details. However, it does not explicitly guide when to use this vs. search_test_case for broader queries or other tools.

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