List Test Cases in Tree

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

With no annotations, the description must fully disclose behavioral traits. It mentions pagination and paging into folders but fails to comment on whether listing is recursive or flat, how permissions work, rate limits, or whether it's a safe read operation. This leaves significant gaps for an agent.

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 two short sentences, front-loading the core action ('List test cases under a project tree with pagination') and providing a key usage hint. Every sentence is concise and contributes meaning.

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 having 10 parameters and no output schema, the description is minimal. It doesn't explain the tree structure, pagination behavior (e.g., default page size, max results), or what the response contains. Given the complexity, more context is needed to make the tool safely and effectively usable.

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 input schema has 100% description coverage, so each parameter is documented. The description adds extra context for parentNodeId ('page into a folder') and implies pagination relates to page/size. This adds marginal value beyond the schema, meeting the baseline of 3.

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 lists test cases under a project tree with pagination, specifying the resource and action. It distinguishes from siblings like testcase_get (single) and testcase_search_by_aql (search) but doesn't elaborate on what 'project tree' implies or differentiate from testplan_get_test_cases.

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 guidance on using parentNodeId to page into a folder, implying usage context. However, it lacks explicit when-to-use vs alternatives, such as when to use this instead of testcase_search_by_aql or testplan_get_test_cases. No exclusions or conditionals are mentioned.

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