Knowledge Base MCP Server

🚀 知識庫 MCP 服務器

本 MCP 服務器提供實用工具，可用於列出並檢索不同知識庫中的內容，為知識管理和查詢提供便利。

🚀 快速開始

此 MCP 服務器能幫助您高效管理和檢索知識庫內容。使用前，請確保已完成安裝和配置。

✨ 主要特性

• 提供知識庫管理工具，可創建和更新知識庫。
• 具備檢索工具，能從知識庫中檢索信息。
• 支持多參數設置，如指定知識庫、控制結果數量和相似度閾值。
• 輸出結果為 Markdown 格式，包含相關段落內容、源文件路徑等信息。

📦 安裝指南

這些說明假設您已經在系統中安裝了 Node.js 和 npm。

先決條件

• Node.js（版本 16 或更高）
• npm（Node 包管理器）

安裝步驟

1. 克隆倉庫：

   git clone <repository_url>
   cd knowledge-base-mcp-server
   

2. 安裝依賴項：

   npm install
   

3. 配置環境變量：
   • 服務器需要設置 HUGGINGFACE_API_KEY 環境變量，這是用於生成知識庫內容嵌入的 Hugging Face 推理 API 密鑰。您可以在 Hugging Face 網站 (https://huggingface.co/) 上免費獲取一個 API 密鑰。
   • 服務器需要設置 KNOWLEDGE_BASES_ROOT_DIR 環境變量，此變量指定知識庫子目錄所在的目錄。如果您未設置此變量，它將默認為 $HOME/knowledge_bases，其中 $HOME 是當前用戶的主目錄。
   • 服務器支持 FAISS_INDEX_PATH 環境變量來指定 FAISS 索引的路徑。如果未設置，默認值為 $HOME/knowledge_bases/.faiss。
   • 服務器支持 HUGGINGFACE_MODEL_NAME 環境變量來指定用於生成嵌入的 Hugging Face 模型。如果未設置，默認值為 "sentence-transformers/all-mpnet-base-v2"。
   • 請將以下環境變量添加到您的 shell 配置文件（如 .bashrc 或 .zshrc）中：

     export HUGGINGFACE_API_KEY="your_api_key"
     export KNOWLEDGE_BASES_ROOT_DIR="/path/to/knowledge_bases"
     export FAISS_INDEX_PATH="/path/to/faiss_index"
     

4. 運行服務器：

   npm run dev
   

💻 使用示例

基礎用法

知識庫管理工具 (manage_knowledge_base)

此工具用於創建和更新知識庫。您可以通過以下命令與它交互：

npm run manage-knowledge-base

• 創建新知識庫：

node manage_knowledge_base.js create <knowledge_base_name>

• 更新現有知識庫：

node manage_knowledge_base.js update <knowledge_base_name> --add <file_path> [--recursive]

檢索工具 (retrieve_knowledge)

此工具用於從知識庫中檢索信息。您可以通過以下命令與它交互：

npm run retrieve-knowledge

• 搜索所有知識庫：

node retrieve_knowledge.js search "您的查詢問題"

• 指定特定知識庫：

node retrieve_knowledge.js search --knowledge_base <knowledge_base_name> "您的查詢問題"

• 設置結果數量和閾值：

node retrieve_knowledge.js search --top_n 5 --threshold 1.5 "您的查詢問題"

高級用法

輸出格式

檢索工具的輸出為 Markdown 格式的字符串，結構如下：

## 同義詞搜索結果

**結果 1:**

[最相關的段落內容]

**來源：**
```json
{
  "source": "[包含該段落的文件路徑]"
}

結果 2:

[第二相關段落內容]

來源：

{
  "source": "[包含該段落的文件路徑]"
}

免責聲明: 提供的結果可能並非全部都相關。請交叉驗證信息的相關性。

每個結果包括最相關的段落內容、源文件路徑和相似度分數。

## 📚 詳細文檔
### 知識庫管理工具 (`manage_knowledge_base`)
#### 創建新知識庫
```bash
node manage_knowledge_base.js create <knowledge_base_name>

此命令將在 $KNOWLEDGE_BASES_ROOT_DIR 目錄下創建一個名為 <knowledge_base_name> 的新知識庫目錄，並初始化必要的配置文件。

更新現有知識庫

node manage_knowledge_base.js update <knowledge_base_name> --add <file_path> [--recursive]

此命令允許您將文件添加到指定的知識庫中。如果啟用 --recursive 標誌，它將在給定路徑及其子目錄中遞歸查找所有文件。

檢索工具 (retrieve_knowledge)

基本檢索

node retrieve_knowledge.js search "您的查詢問題"

此命令將搜索所有註冊的知識庫，並返回與查詢最相關的段落。

指定知識庫

node retrieve_knowledge.js search --knowledge_base <knowledge_base_name> "您的查詢問題"

此命令允許您指定要搜索的特定知識庫。

控制結果數量和相似度閾值

node retrieve_knowledge.js search --top_n 5 --threshold 1.5 "您的查詢問題"

通過 --top_n 參數，您可以控制返回的最大結果數量。通過 --threshold 參數，您可以設置相似度分數的最低閾值。

後臺運行

要以後臺服務的形式運行服務器，請參考項目中的服務啟動腳本和配置文件。

🔧 技術細節

項目結構

knowledge-base-mcp-server/
├── package.json           # 項目的 npm 包配置
├── src/                  # 源代碼目錄
│   ├── manage_knowledge_base.js  # 知識庫管理工具
│   └── retrieve_knowledge.js     # 檢索工具
└── README.md             # 項目說明文檔

依賴項

{
  "dependencies": {
    "@sentence-transformers/all-mpnet-base-v2": "^1.14.0",
    "faiss-js": "^0.5.3",
    "fs-extra": "^9.1.0",
    "node-yaml": "^5.1.0"
  }
}

📄 許可證

貢獻者

• [您的姓名或 GitHub 用戶名]

致謝

感謝您對本項目的貢獻！