Jeanibarz Knowledge Base MCP Server

🚀 知識庫 MCP 服務器

此 MCP 服務器為您提供工具，用於列出和檢索來自不同知識庫的內容，助力您高效管理和獲取知識信息。

🚀 快速開始

此 MCP 服務器為您提供工具來列出和檢索來自不同知識庫的內容。您可以通過以下步驟快速開啟使用。

✨ 主要特性

• 列出知識庫：獲取所有註冊的知識庫及其元數據。
• 檢索知識內容：根據查詢語句檢索相關知識文檔。支持指定特定知識庫進行搜索或跨所有知識庫搜索。

📦 安裝指南

這些說明假設您已經在系統上安裝了 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-MiniLM-L6-v2。
   • 您可以在 .env 文件或系統環境中配置這些環境變量。
4. 構建服務器：

   npm run build
   

5. 添加到 MCP 設置： 要將此服務器添加到 MCP 界面，請按照 MCP 文檔中的說明進行操作。確保 MCP 已正確配置以識別此服務器，並設置必要的權限。
6. 創建知識庫目錄： 在開始之前，建議您為每個知識庫創建適當的目錄結構。例如：

   knowledge_bases/
     ├── doc1.md
     ├── doc2.pdf
     └── subdirectory/
         └── file.txt
   

💻 使用示例

基礎用法

檢索知識工具

retrieve_knowledge 工具執行語義搜索，使用 FAISS 索引。該索引在服務器啟動時自動更新，或者在檢測到知識庫文件更改時更新。

輸出格式

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

## 語義搜索結果

**結果 1：**

[最相似片段的內容]

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

結果 2：

[第二個最相似片段的內容]

來源：

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

免責聲明： 提供的結果可能並非全部相關。請檢查信息的相關性。

每個結果都包含最相似片段的內容、來源文件路徑和相似度評分。

#### 示例用法
通過 MCP 界面使用工具：
```json
{
  "tool": "retrieve_knowledge",
  "args": {
    "query": "您的查詢語句。",
    "knowledge_base": "指定知識庫名稱（可選）",
    "threshold": 2.0
  }
}

參數說明

• query：必填。要檢索的信息的查詢語句。
• knowledge_base：可選。指定特定知識庫進行搜索；如果不指定，默認搜索所有知識庫。
• threshold：可選。相似度閾值，低於該閾值的結果將被返回。默認為 2.0。

示例輸出

{
  "result": [
    {
      "content": "相關片段內容。",
      "source": "文件路徑",
      "score": 1.5
    },
    {
      "content": "另一個相關片段內容。",
      "source": "另一個文件路徑",
      "score": 1.8
    }
  ],
  "message": "搜索完成。"
}

⚠️ 注意事項

⚠️ 重要提示

• 確保所有知識庫文件都是可讀的，並且服務器具有適當的文件權限。
• 定期更新知識庫以保持索引是最新的。
• 調整相似度閾值以優化檢索結果的相關性。

通過遵循這些步驟，您可以有效地利用此 MCP 服務器來管理、搜索和檢索您的知識內容。