flaky_test_detector

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

No annotations provided. Description adds flakiness criteria and output format, but doesn't state read-only nature or side effects. Partial transparency.

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 plus definition. Zero waste, front-loaded with action and criteria.

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?

No output schema; description mentions 'run-by-run trace' which provides expected output. Could be more detailed on trace format, but sufficient for a simple tool.

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 0%. Description explains case_id and last_n_runs (N) but does not mention project_id parameter. Adds some value beyond schema but incomplete.

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?

Description clearly states it pulls a test case's result across multiple runs and flags flakiness, with specific definition. Distinguishes from sibling tools like get_results_for_run.

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?

Implied use for flakiness detection, but no explicit when-to-use vs alternatives like get_results_for_run or get_test_case. Missing guidance on prerequisites.

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