Fastmcp Godot Rag

🚀 FastMCP Godot Documentation RAG

FastMCP Godot Documentation RAG 是一個基於檢索增強生成（RAG）的命令行助手，可用於查詢和解讀 Godot 引擎的官方文檔。該項目藉助 Hugging Face 語義向量模型和 FAISS 構建向量數據庫，再通過 FastMCP 註冊工具，結合 DeepSeek Chat API 返回結構化回答。

🚀 快速開始

運行概覽

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 文檔知識庫進行交互式問答。

✨ 主要特性

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 兩個 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 工具與命令行入口。