Fastmcp Godot Rag

🚀 FastMCP Godot Documentation RAG

FastMCP Godot Documentation RAG は、検索強化生成（RAG）に基づくコマンドラインヘルパーです。このツールは、Godot エンジンの公式ドキュメントを検索し、解釈するために使用されます。プロジェクトでは、Hugging Face の意味ベクトルモデルと FAISS を使用してベクトルデータベースを構築し、FastMCP 登録ツールを通じて DeepSeek Chat API と組み合わせて構造化された回答を返します。

✨ 主な機能

🔍 核心流程

1. ドキュメントの前処理
   • rst_to_markdown.py を使用して、公式の .rst ドキュメントを一括で構造化された Markdown に変換します。この際、シグナル、テーブル、章情報を保持します。
   • markdown_split.py では、Markdown 内の章、テーブル、コードなどのコンテンツタイプを識別し、RAG に適した JSON フラグメントに分割します。
2. ベクトル化とインデックスの構築
   • embedding.py は godot_docs/chunks.json を読み込み、sentence-transformers/all-miniLM-L6-v2 を使用してテキスト埋め込みを生成し、結果をローカルの FAISS インデックスとメタデータファイルに書き込みます。
3. 検索と回答
   • rag_fastmcp.py はローカルのベクトルライブラリとメタデータをロードし、search_godot_docs と rag_answer の 2 つの FastMCP ツールを登録し、ドキュメント検索と DeepSeek API を組み合わせた質問応答を実現します。

📁 目录结构

• godot_docs/：変換後の Markdown、分割された JSON、FAISS インデックスなどのデータ資産を保存します。
• classes/：元の .rst ドキュメントのコレクションで、データ変換の入力として使用できます。
• rst_to_markdown.py：一括で rst→md を変換するスクリプトです。
• markdown_split.py：Markdown をスマートに分割するスクリプトです。
• embedding.py：ベクトル化とインデックス構築のスクリプトです。
• rag_fastmcp.py：インデックスをロードし、FastMCP ツールとコマンドラインエントリを提供します。

🚀 クイックスタート

1. データの準備

Godot の .rst ドキュメントを classes/ に配置し、rst_to_markdown.py を実行して godot_docs/md_new/ に出力します。

2. ドキュメントの分割

markdown_split.py を実行して、構造化された godot_docs/chunks.json を生成します。

3. インデックスの構築

embedding.py を実行して、godot_docs/faiss_db/index.faiss と metadata.pkl を生成します。

4. ヘルパーの起動

DEEPSEEK_API_KEY を設定（またはコード内に組み込まれたデモキーを使用）し、rag_fastmcp.py を実行してコマンドラインヘルパーを起動します。

以上の手順を完了すると、FastMCP インターフェイスまたはコマンドラインを通じて、ローカルの Godot ドキュメント知識ベースと対話型の質問応答を行うことができます。