Get Test Manager Test Case Instances by Test Run ID

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

With no annotations, the description fully carries the burden. It explicitly states the tool is read-only, explains the entry semantics (test case x environment pairing), details automation-specific fields, and describes pagination/filtering behavior. 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?

The description is long but well-structured: purpose first, then terminology clarification, sibling comparison, automation details, filtering, and read-only note. Every sentence adds value, though it could be slightly tighter. Front-loaded with core purpose.

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 no output schema and complex parameter set, the description covers the output structure (breakdown + per-instance entries with fields), automation extras, pagination, and filtering. Lacks explicit mention of default pagination values or status format strictness, but overall sufficiently 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 description coverage is 0%, so the description must add meaning. It explains test_run_id implicitly, notes pagination (page, per_page) and filtering by status and assignee, and gives example status values. However, it does not specify default values or constraints like max per_page, and assignee is only mentioned as user ID without further detail.

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 verb ('Retrieves') and resource ('test case instances by test run ID'). It distinguishes itself from the sibling tool tm.get_testRunById by contrasting planned composition vs actual results, and from other list tools by its specific scope.

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?

Provides explicit context on when to use: for actual execution results vs tm.get_testRunById for planned composition. Mentions filtering and pagination options, guiding the agent on parameter usage. Does not list all alternatives but the single sibling comparison is effective.

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