read_test_case

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

With no annotations provided, the description carries the full burden of disclosing behavior. It implies a read operation via 'Fetch' but does not explicitly state that it is read-only, nor does it describe what happens if neither ID is provided, if both are provided, or if the test case is not found. The behavior beyond identification is largely undisclosed.

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 a single sentence that conveys the core functionality and lookup modes, with no redundant wording. The inclusion of the API method name adds reference value without bloat.

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?

Despite being a simple read tool, the absence of an output schema and annotations means the description should explain the return value and error behavior. It does not, leaving agents uncertain about what the tool returns or how failures are handled. The description is adequate for identifying the tool but incomplete for operational 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?

The schema descriptions cover all three parameters, so the baseline is 3. The description adds useful relational context by indicating that IDs are alternatives and that version is optional with external ID, which is slightly beyond the schema but not extensive.

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 action (fetch), resource (test case), and identifies two lookup methods (internal id or external id with optional version). It also includes the API method name (tl.getTestCase) for reference. This distinguishes it from sibling read tools like read_test_execution and get_requirement.

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 gives clear context on how to identify a test case (by internal or external ID) and notes the optional version parameter. However, it does not explicitly mention when to use this tool over alternatives or any exclusions. Since no alternative for reading test cases exists among siblings, this is clear but not fully explicit.

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