Probonobonobo Sui MCP Server

該項目實現了一個基於MCP協議的服務器，集成FAISS向量數據庫和RAG技術，支持從GitHub提取Move文件並構建知識庫，提供文檔檢索和增強生成功能。

開發者工具知識管理與記憶 #MCP服務 #向量檢索 #RAG #Move文件 .Python

評分 : 2分

下載量 : 11

更新時間 : 2025-04-29

什麼是MCP服務器？

MCP服務器是一個基於FastAPI的AI工具，它允許用戶通過查詢向量數據庫來獲取相關文檔，用於生成更智能的回答。該服務器集成了FAISS向量存儲和GitHub Move文件提取功能。

如何使用MCP服務器？

用戶可以通過命令行或API調用輕鬆啟動服務器、下載Move文件、構建索引以及執行查詢。

適用場景

適合需要快速檢索大量文檔、生成結構化回答的場景，例如技術文檔搜索、知識庫管理和代碼分析。

主要功能

GitHub Move文件提取從GitHub中自動提取與Sui Move語言相關的文件，支持多種搜索策略。

FAISS向量存儲利用FAISS高效存儲和檢索文檔嵌入向量。

RAG集成結合檢索增強生成（RAG）技術，生成更準確的回答。

簡單易用的API提供RESTful API接口，方便與其他系統集成。

優勢與侷限性

優勢

高效的文檔檢索能力

支持多種文檔格式

易於擴展和定製

開源免費

侷限性

對高併發請求可能性能有限

依賴外部API（如GitHub）

需要一定的硬件資源

如何使用

安裝MCP服務器

通過pipx或手動方式安裝MCP服務器。

下載GitHub Move文件

使用命令行下載與Sui Move相關的文件。

構建索引

將下載的文件索引到FAISS數據庫中。

運行服務器

啟動MCP服務器以開始處理查詢。

使用案例

案例1：技術文檔搜索用戶查詢Sui Move語言中的模塊定義。

案例2：代碼分析用戶需要了解Sui Move中關於交易處理的部分。

常見問題

如何安裝MCP服務器？

MCP服務器支持哪些文件格式？

是否需要GitHub API Token？

🚀 MCP 服務器

MCP（Message Communication Protocol）服務器是一個基於 FastAPI 和 FAISS 的快速 API 服務，主要用於支持 RAG（檢索增強生成）應用程序。它能幫助開發者高效地構建和使用相關應用，為 RAG 場景提供有力支持。

🚀 快速開始

安裝依賴

在項目根目錄中運行以下命令安裝所有必要的依賴：

pip install -r requirements.txt

配置環境變量

複製 .env.example 文件並命名為 .env，然後根據需要修改配置：

GITHUB_TOKEN=your_github_token_here
OPENAI_API_KEY=your_openai_api_key_here

✨ 主要特性

MCP API 實現 (`mcp_api.py`)

提供以下主要接口：

/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}}'

文檔索引 (`index_move_files.py`)

將文檔轉換為文本並存儲到 FAISS 索引中：

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

本地查詢 (`local_query.py`)

直接從索引中檢索相關文檔：

python local_query.py "What is RAG?"

📦 安裝指南

安裝依賴

在項目根目錄中運行以下命令安裝所有必要的依賴：

pip install -r requirements.txt

配置環境變量

複製 .env.example 文件並命名為 .env，然後根據需要修改配置：

GITHUB_TOKEN=your_github_token_here
OPENAI_API_KEY=your_openai_api_key_here

💻 使用示例

基礎用法

MCP API 請求示例

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}}'

文檔索引命令示例

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

本地查詢命令示例

python local_query.py "What is RAG?"

高級用法

RAG 管道實現

完整的 RAG 工作流程如下：

搜索查詢：用戶提交一個問題
檢索：系統從向量數據庫中找到相關文檔
上下文構建：將檢索到的文檔格式化為提示
LLM 生成：提示被髮送到 LLM 模型，結合檢索到的內容
增強響應：LLM 根據提供的信息生成答案

該流程在 rag_integration.py 中有完整實現。

📚 詳細文檔

項目目錄結構

mcp_server/
├── __init__.py             # 包初始化文件
├── main.py                # 主服務器文件
├── mcp_api.py             # MCP API 實現文件
├── index_move_files.py    # 文件索引工具
├── local_query.py         # 本地查詢工具
├── download_move_files.py # GitHub Move 文件提取器
├── rag_integration.py     # LLM 集成模塊
├── pyproject.toml         # 包配置文件
├── requirements.txt       # 依賴管理文件
├── .env.example           # 環境變量示例文件
├── README.md              # 項目說明文檔
├── data/                  # 數據存儲目錄
├── docs/                  # 示例文檔目錄
│   └── move_files/        # 下載的 Move 文件存放目錄
├── models/                # 模型實現目錄
│   └── vector_store.py    # FAISS 矢量存儲實現
└── utils/
    ├── document_processor.py  # 文檔處理工具
    └── github_extractor.py    # GitHub 文件提取工具

🔧 技術細節

MCP 服務器基於 FastAPI 和 FAISS 構建。FastAPI 提供了高效的 API 服務，能夠快速處理用戶請求。FAISS 則用於文檔的索引和檢索，通過將文檔轉換為向量並存儲在索引中，實現快速的文檔檢索。在 RAG 場景中，系統首先根據用戶的查詢從 FAISS 索引中檢索相關文檔，然後將這些文檔作為上下文與用戶查詢一起發送給 LLM 模型，LLM 模型根據這些信息生成最終的答案。