Skip to main content
Glama

search_tests

Search test case documents in the knowledge base to check what is already covered and avoid duplicates before writing new test cases.

Instructions

Search test case documents in the knowledge base. Read-only, no side effects.

    Call BEFORE write_test_case() to check what is already covered and
    avoid duplicates. Equivalent to search_by_type(query, "test") but
    more intent-clear for test-coverage workflows.

    Args:
        query: What to search for (e.g. "authentication edge cases")
        top_k: Number of results to return (default: 5)
        project: Target project name (optional)

    Returns:
        Ranked test case chunks with scenario, steps, expected result,
        and status. Returns a prompt to call write_test_case() when empty.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
top_kNo
projectNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations, the description transparently discloses it is read-only with no side effects. It describes return fields and signals when to call write_test_case, though lacks details on pagination or error handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with sections for purpose, usage, args, and returns. It is informative but could be slightly more concise; the bullet-like args section is clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (3 parameters, output schema exists), the description covers purpose, usage, behavior, parameters, and return values thoroughly without relying on structured fields.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage, but the description fully compensates by defining each parameter with examples and defaults, adding meaning beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool searches test documents and is read-only. It distinguishes itself from the sibling 'search_by_type' by noting it is 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.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly advises calling this tool before write_test_case() to avoid duplicates. References an alternative (search_by_type) and clarifies when this tool should be used.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dl4rce/flaiwheel'

If you have feedback or need assistance with the MCP directory API, please join our Discord server