Skip to main content
Glama
Local Development MCP Server

Local Development MCP Server

by lreb

index-documents

Index PDF documents from a directory into a named searchable collection to enable quick content lookup.

Instructions

Index all PDF documents in a directory for fast searching

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": {
      "directory": "<directory>",
      "indexName": "<indexName>"
    },
    "name": "index-documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
directoryYesPath to directory containing PDF files
indexNameYesName for this document index

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 behavioral disclosure burden. It says the tool indexes all PDFs in a directory, but does not state whether indexing is recursive, whether an existing index with the same name is overwritten, what permissions are needed, or what the operation returns.

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 a single front-loaded sentence with no wasted wording. It efficiently conveys the core operation and intended benefit.

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 tool that creates or updates an index with no annotations and no output schema, the description is incomplete. It omits important context such as index lifecycle behavior, relationship to search-documents, overwrite semantics, and any output or error expectations.

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 description coverage is 100%, so the input schema already documents both required parameters. The description adds little beyond that and does not clarify constraints such as path validation or index naming rules.

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?

The description clearly states a specific verb and resource: indexing PDF documents in a directory for fast searching. It does not explicitly distinguish this from siblings such as search-documents or list-indexes, but the purpose is still clear.

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 explicit when-to-use guidance, no exclusions, and no mention of alternatives such as search-documents or list-indexes. The purpose implies usage, but an agent receives no routing guidance.

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