Skip to main content
Glama

Semantic Search (RAG)

rag_search
Read-onlyIdempotent

Search indexed documents by meaning to retrieve relevant passages with source files, grounding answers in your own data.

Instructions

Search previously indexed documents by meaning and return the most relevant passages with their source files. Use this to ground answers in the user's own files/docs that you indexed with rag_index.

Requires an embedding server (LM Studio or llama.cpp) running with an embedding model loaded.

Args:

  • query (string): What to look for (a question or topic).

  • top_k (number): Number of passages to return, 1-20 (default 5).

Returns ranked { source, score, text } passages.

Example: { "query": "how is authentication handled", "top_k": 5 }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch query
top_kNoPassages to return
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds important operational context: the need for an embedding server. This goes beyond the annotations, providing transparency on runtime dependencies.

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

Conciseness5/5

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

The description is concise, well-structured with a clear opening sentence, followed by prerequisite, args, returns, and example. No wasted words.

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 simplicity (2 params, no output schema), the description covers everything: purpose, prerequisite, parameters with detail, return format, and an example. It is fully complete for its complexity.

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

Parameters4/5

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

Schema coverage is 100%, baseline 3. The description adds meaningful clarifications: query is 'What to look for (a question or topic)' and top_k is 'Number of passages to return, 1-20 (default 5)', which enhances understanding beyond the schema's minimal descriptions.

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 it is a semantic search tool for previously indexed documents, returning relevant passages with source files. It distinguishes itself from siblings like web_search by focusing on user's own indexed docs.

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

Usage Guidelines4/5

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

The description explicitly advises using this tool to ground answers in indexed documents, implying when to use. It also mentions the prerequisite of a running embedding server, providing clear context. However, it doesn't explicitly list when not to use it.

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/highercomve/mcptools'

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