Skip to main content
Glama
enesjakozh

MCP RAG Server

by ProbonoBonobo
GitHub
Python
4
  • Apple
  • Linux
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

RAG 向け FAISS 搭載 MCP サーバー

このプロジェクトは、AI エージェントがベクター データベースを照会し、検索拡張生成 (RAG) に関連するドキュメントを取得できるようにする Machine Conversation Protocol (MCP) サーバーの概念実証実装を提供します。

特徴

  • 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
    • RAG 統合用の OpenAI またはその他の LLM API キーを追加します: OPENAI_API_KEY=your_key_here

手動インストール

pipx を使用したくない場合は、次の手順に従ってください。

  1. リポジトリをクローンする
  2. 依存関係をインストールします:
cd mcp_server pip install -r requirements.txt

pipxでの使用

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ファイルをインテリジェントにフィルタリングします
  • ダウンロード後にベクターデータベースを常に再構築します

インデックス作成ファイルの移動

# 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 (Retrieval-Augmented Generation) パイプラインは次のように機能します。

  1. 検索クエリ: ユーザーが質問を送信する
  2. 検索: システムはベクターデータベースから関連文書を検索します
  3. コンテキスト形成: 取得した文書はプロンプトにフォーマットされる
  4. LLM生成: プロンプトは取得されたコンテキストとともにLLMに送信される。
  5. 強化された応答: LLMは取得した情報に基づいて回答を提供します

このワークフローはrag_integration.pyモジュールに完全に実装されており、コマンドラインから、または独自のアプリケーションのライブラリとして使用できます。

GitHub 移動ファイルの抽出

このシステムは、検索クエリに基づいてGitHubからMoveファイルを抽出できます。以下の2つのメソッドを実装しています。

  1. GitHub API （推奨）：より高いレート制限にはGitHubトークンが必要です
  2. Webスクレイピングフォールバック: 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言語の解析を改善

ライセンス

マサチューセッツ工科大学

This server cannot be installed

-
security - not tested
F
license - not found
-
quality - not tested

How are these scores calculated?

local-only server

The server can only run on the client's local machine because it depends on local resources.

AI エージェントが Sui Move 言語ドキュメントを含む FAISS ベクトル データベースを照会して検索拡張生成を実行できるようにする機械会話プロトコル サーバー。

  1. 特徴
    1. インストール
      1. pipxの使用（推奨）
      2. 手動インストール
    2. pipxでの使用
      1. GitHubからMoveファイルをダウンロードする
      2. GitHub の検索とインデックスの改善（推奨）
      3. インデックス作成ファイルの移動
      4. ベクターデータベースのクエリ
      5. LLM統合によるRAGの使用
      6. サーバーの実行
    3. 手動での使用（pipxなし）
      1. サーバーの起動
      2. GitHubからMoveファイルをダウンロードする
      3. 文書のインデックス作成
      4. ドキュメントのクエリ
      5. LLM統合によるRAGの使用
      6. MCP APIエンドポイント
    4. 完全なRAGパイプライン
      1. GitHub 移動ファイルの抽出
        1. プロジェクト構造
          1. プロジェクトの拡張
            1. ライセンス

              Related MCP Servers

              • MCP Feishu Project Manager

                Roland0511
                A
                security
                A
                license
                A
                quality
                A Model Context Protocol server that enables AI assistants to interact with Feishu project management systems, allowing retrieval of project views and work items.
                Last updated -
                4
                5
                Python
                MIT License
                • Apple

              • AivisSpeech MCP Server

                kentaro
                A
                security
                F
                license
                A
                quality
                A Model Context Protocol server that enables AI assistants to utilize AivisSpeech Engine's high-quality voice synthesis capabilities through a standardized API interface.
                Last updated -
                1
                TypeScript

              • SupaUI MCP Server

                buoooou
                A
                security
                F
                license
                A
                quality
                A Model Context Protocol server that enables AI agents to generate, fetch, and manage UI components through natural language interactions.
                Last updated -
                3
                431
                4
                TypeScript

              • Logseq MCP Tools

                mikeysrecipes
                A
                security
                A
                license
                A
                quality
                A Model Context Protocol server that enables AI agents to interact with a local Logseq instance, allowing operations like creating pages, managing blocks, and searching across a knowledge graph.
                Last updated -
                13
                1
                Python
                MIT License
                • Apple

              View all related MCP servers

              Appeared in Searches

              New MCP Servers

              MCP directory API

              We provide all the information about MCP servers via our MCP API.

              curl -X GET 'https://glama.ai/api/mcp/v1/servers/ProbonoBonobo/sui-mcp-server'

              If you have feedback or need assistance with the MCP directory API, please join our Discord server