MCP Server with FAISS for RAG
2025.03.31
1
Python向量数据库文档检索RAG工作流Sui Move语言处理开发效率数据库
sui-mcp-server 是一个基于 Machine Conversation Protocol (MCP) 的服务，集成了 FAISS 向量数据库，用于支持 Retrieval-Augmented Generation (RAG) 工作流。它能够从 GitHub 提取 Move 文件，进行文档分块和嵌入，并通过 LLM 集成实现完整的 RAG 流程。
View on GitHub
Overview
基本能力
产品定位
sui-mcp-server 是一个用于支持 Retrieval-Augmented Generation (RAG) 工作流的服务，特别适用于处理 Sui Move 语言相关的文档检索和生成任务。
核心功能
- FastAPI 服务器，提供 MCP 端点
- 集成 FAISS 向量数据库
- 文档分块和嵌入
- GitHub Move 文件提取和处理
- LLM 集成，支持完整的 RAG 工作流
- 提供简单的客户端示例和示例文档
适用场景
- 从 GitHub 提取 Sui Move 文件并进行索引
- 基于向量数据库的文档检索
- 结合 LLM 的 RAG 工作流
- Sui Move 语言相关的开发和研究
工具列表
mcp-download: 从 GitHub 下载 Move 文件mcp-search-index: 增强的 GitHub 搜索和索引功能mcp-index: 索引文件mcp-query: 查询向量数据库mcp-rag: 使用 RAG 与 LLM 集成mcp-server: 启动服务器
常见问题解答
- 如何配置 GitHub token？
在
.env文件中设置GITHUB_TOKEN=your_token_here - 如何配置 LLM API key？
在
.env文件中设置OPENAI_API_KEY=your_key_here - 如何自定义索引文件位置？
使用
--index-file参数指定自定义路径
使用教程
使用依赖
- 安装 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
安装教程
- 使用 pipx 安装：
cd /path/to/mcp-server-project
pipx install -e .
- 手动安装：
cd mcp_server
pip install -r requirements.txt
调试方式
- 启动服务器：
mcp-server
- 下载 Move 文件：
mcp-download --query "use sui" --output-dir docs/move_files
- 索引文件：
mcp-index
- 查询向量数据库：
mcp-query "What is a module in Sui Move?"
- 使用 RAG：
mcp-rag "What is a module in Sui Move?"