知识库 MCP 服务器

此 MCP 服务器提供用于列出和检索来自不同知识库的内容的工具。

<a href="https://glama.ai/mcp/servers/n0p6v0o0a4"> <img width="380" height="200" src="https://glama.ai/mcp/servers/n0p6v0o0a4/badge" alt="Knowledge Base Server MCP server" /> </a>

设置说明

以下说明假设您的系统上已安装 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 Inference API 的 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。
   • 您可以在 .bashrc 或 .zshrc 文件中设置这些环境变量，也可以直接在 MCP 设置中设置。

4. 构建服务器：

   npm run build
   

5. 将服务器添加到 MCP 设置：

   • 编辑位于 /home/jean/.vscode-server/data/User/globalStorage/saoudrizwan.claude-dev/settings/ 的 cline_mcp_settings.json 文件。
   • 将以下配置添加到 mcpServers 对象：

   "knowledge-base-mcp": {
     "command": "node",
     "args": [
       "/path/to/knowledge-base-mcp-server/build/index.js"
     ],
     "disabled": false,
     "autoApprove": [],
     "env": {
       "KNOWLEDGE_BASES_ROOT_DIR": "/path/to/knowledge_bases",
       "HUGGINGFACE_API_KEY": "YOUR_HUGGINGFACE_API_KEY",
     },
     "description": "从知识库中检索基于查询的相似块。"
   },
   

   • 将 /path/to/knowledge-base-mcp-server 替换为服务器目录的实际路径。
   • 将 /path/to/knowledge_bases 替换为知识库目录的实际路径。

6. 创建知识库目录：

   • 在 KNOWLEDGE_BASES_ROOT_DIR 中为每个知识库创建子目录（例如，company、it_support、onboarding）。
   • 将包含知识库内容的文本文件（例如，.txt、.md）放置在这些子目录中。

• 服务器递归读取指定知识库子目录中的所有文本文件（例如，.txt、.md）。
• 服务器跳过隐藏文件和目录（以 . 开头的文件和目录）。
• 对于每个文件，服务器计算 SHA256 哈希值，并将其存储在隐藏的 .index 子目录中具有相同名称的文件中。 此哈希值用于确定自上次索引以来文件是否已修改。
• 文件内容使用 langchain/text_splitter 中的 MarkdownTextSplitter 分割成块。
• 然后将每个块的内容添加到 FAISS 索引，该索引用于相似性搜索。
• FAISS 索引在服务器启动时自动初始化。 它检查知识库文件中的更改并相应地更新索引。

用法

服务器公开两个工具：

• list_knowledge_bases：列出可用的知识库。
• retrieve_knowledge：根据查询从知识库中检索相似的块。 （可选）如果指定了知识库，则仅搜索该知识库；否则，将考虑所有可用的知识库。 默认情况下，最多返回 10 个文档块，其得分低于 2 的阈值。 可以使用 threshold 参数选择性地提供不同的阈值。

您可以通过 MCP 界面使用这些工具。

retrieve_knowledge 工具使用 FAISS 索引执行语义搜索。 当服务器启动或知识库中的文件被修改时，索引会自动更新。

retrieve_knowledge 工具的输出是一个 markdown 格式的字符串，具有以下结构：

## 语义搜索结果

**结果 1：**

[最相似块的内容]

**来源：**
```json
{
  "source": "[包含该块的文件的路径]"
}
```

---

**结果 2：**

[第二个最相似块的内容]

**来源：**
```json
{
  "source": "[包含该块的文件的路径]"
}
```

> **免责声明：** 提供的结果可能并非都相关。 请交叉检查信息的关联性。

每个结果都包括最相似块的内容、源文件和相似度得分。