alm_get_test_case

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

No annotations exist, so description carries all burden. It fails to mention authentication, error handling (e.g., invalid ID), or response behavior. Only basic output format is given.

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?

Description is concise with clear Args and Returns sections. No unnecessary words, but could be slightly more structured for readability.

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 simple tool (1 param, no output schema), description covers purpose, parameter, and return format. Missing error details but adequate for typical use.

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%, so description must add meaning. It adds 'ALM numeric ID', which clarifies the type despite schema saying 'string'. Not exhaustive but helpful.

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 retrieves full details of a test case by ID, including all ALM fields. This distinguishes it from siblings like alm_create_test_case or alm_find_test_by_name.

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 does not explicitly guide when to use this tool over alternatives. It only implies use for retrieval by ID, but lacks context like 'use when you have the ID' or contrast with list tools.

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