MCP Server with FAISS for RAG

该项目提供了一个机器对话协议（MCP）服务器的概念验证实现，允许AI代理查询向量数据库并检索用于检索增强生成（RAG）的相关文档。

功能

• 带有MCP端点的FastAPI服务器
• FAISS向量数据库集成
• 文档分块和嵌入
• GitHub Move文件提取和处理
• 用于完整RAG工作流的LLM集成
• 简单的客户端示例
• 示例文档

安装

使用pipx（推荐）

pipx 是一个帮助你在隔离环境中安装和运行Python应用程序的工具。

1. 首先，如果你还没有安装pipx，请安装它：

# 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

1. 从项目目录直接安装MCP服务器包：

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

# Install in editable mode
pipx install -e .

1. （可选）配置环境变量：
   • 将.env.example复制为.env
   • 添加你的GitHub令牌以提高速率限制：GITHUB_TOKEN=your_token_here
   • 添加你的OpenAI或其他LLM API密钥以进行RAG集成：OPENAI_API_KEY=your_key_here

手动安装

如果你不想使用pipx：

1. 克隆仓库
2. 安装依赖项：

cd mcp_server
pip install -r requirements.txt

使用pipx

安装完成后，你将可以访问以下命令：

从GitHub下载Move文件

# 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

改进的GitHub搜索和索引（推荐）

# 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

mcp-search-index命令提供了增强的GitHub仓库搜索功能：

• 首先搜索仓库，然后递归提取Move文件
• 支持多个搜索关键词（逗号分隔）
• 智能过滤包含"use sui"引用的Move文件
• 下载后总是重建向量数据库

索引Move文件

# 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

查询向量数据库

# 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

使用LLM集成的RAG

# 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

运行服务器

# 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

手动使用（不使用pipx）

启动服务器

cd mcp_server
python main.py

服务器将在http://localhost:8000上启动

从GitHub下载Move文件

要从GitHub下载Move文件并填充你的向量数据库：

# Download Move files with default query "use sui"
./run.sh --download-move

# Customize the search query
./run.sh --download-move --github-query "module sui::coin" --max-results 50

# Download, index, and start the server
./run.sh --download-move --index

你也可以直接使用Python脚本：

python download_move_files.py --query "use sui" --output-dir docs/move_files

索引文档

在查询之前，你需要索引你的文档。你可以将文本文件(.txt)、Markdown文件(.md)或Move文件(.move)放在docs目录中。

要索引文档，你可以：

1. 使用带有--index标志的运行脚本：

./run.sh --index

1. 直接使用索引脚本：

python index_move_files.py --docs-dir docs/move_files --index-file data/faiss_index.bin

查询文档

你可以使用本地查询脚本：

python local_query.py "What is RAG?"

# With more options
python local_query.py -k 3 -f "How to define a struct in Sui Move?"

使用LLM集成的RAG

# Direct RAG query with an LLM
python rag_integration.py "What is a module in Sui Move?" --index-file data/faiss_index.bin

# With API key (if you have one)
OPENAI_API_KEY=your_key_here python rag_integration.py "How do coins work in Sui?"

MCP API端点

MCP API端点位于/mcp/action。你可以用它来执行不同的操作：

• retrieve_documents: 为查询检索相关文档
• index_documents: 从目录索引文档

示例：

curl -X POST "http://localhost:8000/mcp/action" -H "Content-Type: application/json" -d '{"action_type": "retrieve_documents", "payload": {"query": "What is RAG?", "top_k": 3}}'

完整的RAG管道

完整的 RAG（检索增强生成）流程如下：

1. 搜索查询：用户提交一个问题
2. 检索：系统在向量数据库中搜索相关文档
3. 上下文构建：将检索到的文档格式化为提示
4. LLM 生成：将带有检索上下文的提示发送给 LLM
5. 增强响应：LLM 根据检索到的信息提供答案

此工作流程在 rag_integration.py 模块中完全实现，可以通过命令行或作为库在您自己的应用程序中使用。

GitHub Move 文件提取

系统可以根据搜索查询从 GitHub 提取 Move 文件。它实现了两种方法：

1. GitHub API（推荐）：需要 GitHub 令牌以获得更高的速率限制
2. 网络爬虫回退：当 API 方法失败或未提供令牌时使用

要配置您的 GitHub 令牌，请将其设置在 .env 文件中或作为环境变量：

GITHUB_TOKEN=your_github_token_here

项目结构

mcp_server/
├── __init__.py             # Package initialization
├── main.py                # Main server file
├── mcp_api.py             # MCP API implementation
├── index_move_files.py    # File indexing utility
├── local_query.py         # Local query utility
├── download_move_files.py # GitHub Move file extractor
├── rag_integration.py     # LLM integration for RAG
├── pyproject.toml         # Package configuration
├── requirements.txt       # Dependencies
├── .env.example           # Example environment variables
├── README.md              # This file
├── data/                  # Storage for the FAISS index
├── docs/                  # Sample documents
│   └── move_files/        # Downloaded Move files
├── models/                # Model implementations
│   └── vector_store.py    # FAISS vector store implementation
└── utils/
    ├── document_processor.py  # Document processing utilities
    └── github_extractor.py    # GitHub file extraction utilities

扩展项目

要扩展这个概念验证：

1. 添加身份验证和安全功能
2. 实现更复杂的文档处理
3. 增加对更多文档类型的支持
4. 与其他 LLM 提供者集成
5. 添加监控和日志记录
6. 改进 Move 语言解析以提取更结构化的数据

许可证

MIT