MCP Rag Server

🚀 mcp-rag-server

A server based on the Model Context Protocol (MCP) that supports Retrieval Augmented Generation (RAG). It can index documents and provide relevant information to large language models through the MCP protocol.

🚀 Quick Start

Step 1: Install Dependencies

npm install

Step 2: Start the Server

npm start

Step 3: Interact with Example Commands

node example.js

✨ Features

• Document Indexing: Reads files, splits the text according to CHUNK_SIZE, and queues them for embedding processing.
• Embedding Processing: Sends each chunk to the embedding API sequentially, and stores the results in an SQLite database.
• Query Function: Embeds the query content, retrieves the most relevant text chunks from the vector store, and returns them to the client.

📦 Installation

npm install mcp-rag-server

💻 Usage Examples

General MCP Client Configuration

{
  "mcpServers": {
    "rag": {
      "command": "npx",
      "args": ["-y", "mcp-rag-server"],
      "env": {
        "BASE_LLM_API": "http://localhost:11434/v1",
        "EMBEDDING_MODEL": "nomic-embed-text",
        "VECTOR_STORE_PATH": "./vector_store",
        "CHUNK_SIZE": "500"
      }
    }
  }
}

Example Interaction

# Index documents
>> tool:embedding_documents {"path":"./docs"}

# Check status
>> resource:embedding-status

<< rag://embedding/status
Current completed count: 123
Failed count: 45
Total count: 678

Usage with MCP Tools

# Index documents
>> tool:embedding_documents {"path":"./docs"}

# Query document content
>> tool:query_document {"query":"Query content", "numberOfChunks":3}

# Get URIs of all documents
>> resource:rag://documents

# Get content of a single document
>> resource:rag://document/path/to/document.txt

Usage with MCP Resources

• rag://documents: Lists URIs of all documents.
• rag://document/{path}: Gets the content of the document at the specified path.
• rag://query-document/{numberOfChunks}/{query}: Retrieves document content related to the query by quantity.
• rag://embedding/status: Checks the current indexing status (completed, failed, total).

📚 Documentation

Configuration Options

Development

npm install
npm run build      # Compile TypeScript code
npm start          # Start the server
npm run watch      # Monitor file changes

🤝 Contribution

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

📄 License

MIT 2025 Quan Le