Skip to main content
Glama
damoqiongqiu

mcp-local-rag

by damoqiongqiu

export_index

Back up or migrate your local RAG index by exporting it to a JSON file, returning the file path and stats on documents, chunks, and file size.

Instructions

Export the current index to a JSON file for backup or migration. Returns the export file path and stats (document count, chunk count, file size). The exported file can be re-imported with a future import_index tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
outputPathNoAbsolute path for the export file. Defaults to "{dbPath}/export-{timestamp}.json".
Behavior4/5

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

With no annotations, the description carries the burden of disclosure. It reveals that the tool returns the export file path and stats (document count, chunk count, file size), and that the output is importable later. It does not mention potential side effects, but the operation is clearly non-destructive and the return information adds useful context.

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 two sentences, front-loaded with the core purpose. Every sentence adds value: purpose, return stats, and future importability. No unnecessary words.

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

Completeness4/5

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

For a simple tool with one optional parameter and no output schema, the description is nearly complete. It states purpose, return values, and use case. It could mention behavior if the output file already exists, but that is a minor gap.

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% because outputPath has a detailed description with default behavior. The tool description does not add extra meaning beyond the schema, but the schema itself is sufficient, so the baseline score of 3 applies.

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's function: 'Export the current index to a JSON file for backup or migration.' This specifies the verb (export), resource (current index), and output (JSON file), distinguishing it from sibling tools like ingest_file, query_documents, and delete_file.

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 provides clear use cases ('for backup or migration') and notes the exported file can be re-imported with a future import_index tool. While it does not explicitly name alternatives or when-not-to-use, the context is sufficient for an agent to decide when to invoke this tool.

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/damoqiongqiu/mcp-local-rag'

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