Skip to main content
Glama
Local Development MCP Server

Local Development MCP Server

by lreb

search-documents

Search indexed documents by index name and query to locate matching terms or topics, with an optional result limit.

Instructions

Search through indexed documents for specific terms or topics

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "indexName": "<indexName>",
      "query": "<query>"
    },
    "name": "search-documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesSearch query
indexNameYesName of the document index to search
maxResultsNoMaximum results to return (default: 10)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It implies a read, but says nothing about matching semantics (substring vs. full-text vs. ranked), empty-result behavior, permissions, or whether results are truncated by maxResults.

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 short, front-loaded sentence with no filler. It is efficient, though its brevity is part of why behavioral and usage context are thin.

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?

With no annotations and no output schema, the description should explain result shape, matching behavior, and how to obtain a valid indexName. For a three-parameter search tool it leaves the agent guessing on all three.

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

Parameters3/5

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

Schema coverage is 100%, so query, indexName and maxResults are already documented with defaults. The phrase 'specific terms or topics' slightly hints at query semantics but adds no format, syntax, or operator detail beyond the schema.

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 verb (search) and resource (indexed documents) plus the kind of match (specific terms or topics). An agent can tell it apart from read-file or list-directory, though the description never names a sibling for contrast.

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?

No guidance on when to choose this over list-indexes, read-file, or read-pdf, and no prerequisite noted that indexName must come from an existing index (list-indexes). The agent must infer the workflow.

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