MCP Server with FAISS for RAG

MCP Server with FAISS for RAG

site icon
2025.04.04 0
Python检索增强生成向量数据库GitHub文件提取LLM集成开发效率数据库
该项目是一个基于FAISS向量数据库的机器对话协议(MCP)服务器,用于实现检索增强生成(RAG)功能。它允许AI代理查询向量数据库并检索相关文档,以增强生成内容的准确性和相关性。
View on GitHub

Overview

基本能力

产品定位

该MCP服务器主要用于支持检索增强生成(RAG)的工作流程,特别适用于需要从大量文档中快速检索相关信息并生成高质量内容的场景。

核心功能

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

适用场景

  • AI代理需要从大量文档中检索信息
  • 开发者需要快速构建RAG应用
  • 需要从GitHub提取和处理Move文件
  • 需要集成LLM进行内容生成

工具列表

  1. mcp-download:从GitHub下载Move文件
  2. mcp-search-index:增强的GitHub搜索和索引功能
  3. mcp-index:索引文件
  4. mcp-query:查询向量数据库
  5. mcp-rag:使用RAG与LLM集成
  6. mcp-server:启动MCP服务器

常见问题解答

  1. 如何配置GitHub令牌?
  2. 复制.env.example.env,并添加GITHUB_TOKEN=your_token_here
  3. 如何配置LLM API密钥?
  4. .env文件中添加OPENAI_API_KEY=your_key_here
  5. 如何自定义索引位置?
  6. 使用--index-file参数指定自定义路径

使用教程

使用依赖

  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. 使用pipx安装(推荐):
cd /path/to/mcp-server-project
pipx install -e .
  1. 手动安装:
cd mcp_server
pip install -r requirements.txt

调试方式

  1. 启动服务器:
mcp-server
  1. 下载Move文件:
mcp-download --query "use sui" --output-dir docs/move_files
  1. 索引文件:
mcp-index
  1. 查询向量数据库:
mcp-query "What is a module in Sui Move?"
  1. 使用RAG:
mcp-rag "What is a module in Sui Move?"

许可证

该项目遵循 MIT 开源许可条款。