MCP Server with FAISS for RAG

This project provides a proof-of-concept implementation of a Machine Conversation Protocol (MCP) server that allows an AI agent to query a vector database and retrieve relevant documents for Retrieval-Augmented Generation (RAG).

Features

• FastAPI server with MCP endpoints
• FAISS vector database integration
• Document chunking and embedding
• GitHub Move file extraction and processing
• LLM integration for complete RAG workflow
• Simple client example
• Sample documents

Installation

Using pipx (Recommended)

pipx is a tool to help you install and run Python applications in isolated environments.

1. First, install pipx if you don't have it:

# On macOS
brew install pipx
pipx ensurepath

# On Ubuntu/Debian
sudo apt update
sudo apt install python3-pip python3-venv
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# On Windows with pip
pip install pipx
pipx ensurepath

2. Install the MCP Server package directly from the project directory:

# Navigate to the directory containing the mcp_server folder
cd /path/to/mcp-server-project

# Install in editable mode
pipx install -e .

3. (Optional) Configure environment variables:
   • Copy .env.example to .env
   • Add your GitHub token for higher rate limits: GITHUB_TOKEN=your_token_here
   • Add your OpenAI or other LLM API key for RAG integration: OPENAI_API_KEY=your_key_here

Manual Installation

If you prefer not to use pipx:

1. Clone the repository
2. Install dependencies:

cd mcp_server
pip install -r requirements.txt

Usage with pipx

After installing with pipx, you'll have access to the following commands:

Downloading Move Files from GitHub

# Download Move files with default settings
mcp-download --query "use sui" --output-dir docs/move_files

# Download with more options
mcp-download --query "module sui::coin" --max-results 50 --new-index --verbose

Improved GitHub Search and Indexing (Recommended)

# Search GitHub and index files with default settings
mcp-search-index --keywords "sui move"

# Search multiple keywords and customize options
mcp-search-index --keywords "sui move,move framework" --max-repos 30 --output-results --verbose

# Save search results and use a custom index location
mcp-search-index --keywords "sui coin,sui::transfer" --index-file custom/path/index.bin --output-results

The mcp-search-index command provides enhanced GitHub repository search capabilities:

• Searches repositories first, then recursively extracts Move files
• Supports multiple search keywords (comma-separated)
• Intelligently filters for Move files containing "use sui" references
• Always rebuilds the vector database after downloading

Indexing Move Files

# Index files in the default location
mcp-index

# Index with custom options
mcp-index --docs-dir path/to/files --index-file path/to/index.bin --verbose

Querying the Vector Database

# Basic query
mcp-query "What is a module in Sui Move?"

# Advanced query with options
mcp-query "How do I define a struct in Sui Move?" -k 3 -f

Using RAG with LLM Integration

# Basic RAG query (will use simulated LLM if no API key is provided)
mcp-rag "What is a module in Sui Move?"

# Using with a specific LLM API
mcp-rag "How do I define a struct in Sui Move?" --api-key your_api_key --top-k 3

# Output as JSON for further processing
mcp-rag "What are the benefits of sui::coin?" --output-json > rag_response.json

Running the Server

# Start the server with default settings
mcp-server

# Start with custom settings
mcp-server --host 127.0.0.1 --port 8080 --index-file custom/path/index.bin

Manual Usage (without pipx)

Starting the server

cd mcp_server
python main.py

The server will start on http://localhost:8000

Downloading Move Files from GitHub

To download Move files from GitHub and popul

... View full README on GitHub