Skip to main content
Glama

test_rag_retrieval

Simulate a test query against the bot's vector index and inspect retrieved chunks.

Input Schema

NameRequiredDescriptionDefault
queryYes
top_kNo
bot_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. 'Simulate' weakly implies a non-mutating dry run, but the definition never confirms that it does not alter the index or consume quota, nor does it describe the shape or ordering of the returned chunks, which is the stated point of the call.

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?

One compact sentence with the action front-loaded and zero filler. It is efficient, though the available space is arguably underused given the undocumented parameters.

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

Completeness2/5

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

For a three-parameter tool with zero schema descriptions, no annotations, and no output schema, the description should explain the parameters and what the returned chunks look like. Neither is covered, leaving an agent able to guess the intent but not to call it precisely.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate and it does not — it never mentions query, bot_id, or top_k. The top_k parameter in particular has a non-obvious default of 4 that an agent would want explained (e.g., max value, effect on latency).

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

Purpose4/5

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

States a specific action (simulate a test query against the vector index) and the resource inspected (retrieved chunks), so the purpose is unambiguous. It does not explicitly distinguish itself from the nearby test_chatbot_reply, which also tests bot behavior, so sibling differentiation is left implicit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

There is no guidance on when to use this versus test_chatbot_reply, discover_knowledge_gaps, or get_knowledge_sync_status — all plausible alternatives in a RAG-debugging workflow. The word 'Simulate' hints at a diagnostic use case, but no conditions, prerequisites, or exclusions are stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources