search_tests

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

Declares read-only and no side effects directly. Discloses that an empty result prompts calling write_test_case(). Missing potential details like authentication needs or rate limits, but sufficient given no annotations.

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?

Well-structured with summary, usage, args, returns sections. Each sentence adds value, though could be slightly more concise without losing clarity.

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?

Covers all aspects: search functionality, parameter usage, return format (ranked chunks with fields), and empty result behavior. Output schema exists, so return details are 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?

Provides detailed parameter descriptions in the Args section (query purpose, top_k default and purpose, project optionality), fully compensating for the 0% schema description coverage.

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?

Clearly states it searches test case documents in the knowledge base, specifying read-only and no side effects. Differentiates from sibling 'search_by_type' by being more intent-clear for test-coverage workflows.

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?

Explicitly recommends calling before write_test_case() to avoid duplicates. Also mentions equivalence to search_by_type but with clearer intent, guiding when to use this over alternatives.

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