DocBase MCP 服务器使用说明

项目简介

docbase-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM 客户端提供访问 DocBase 知识库文章的搜索能力。目前版本主要实现了通过 'docbase-posts-search' 工具在 DocBase 中搜索文章的功能。

主要功能点

文章搜索工具 (docbase-posts-search): 允许 LLM 客户端通过关键词在 DocBase 知识库中搜索文章，并返回文章标题、内容摘要及元数据。

安装步骤

安装依赖: 在项目根目录下运行 'npm install' 命令安装项目依赖。
```
npm install
```
构建服务器: 运行 'npm run build' 命令构建服务器代码。
```
npm run build
```

服务器配置

要将 docbase-mcp-server 添加到 MCP 客户端（例如 Claude Desktop），您需要配置客户端的 MCP 服务器设置。以下是配置示例，您需要根据您的实际情况进行修改。

重要: 您需要提前获取 DocBase 的访问令牌 (ACCESS_TOKEN) 和团队域名 (TEAM_NAME) 并配置到服务器的环境变量中。

配置文件位置:

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容示例:

{
  "mcpServers": {
    "docbase-mcp-server": {
      "command": "/path/to/docbase-mcp-server/build/index.js",
      "args": [],
      "environment": {
        "DOCBASE_ACCESS_TOKEN": "your-access-token",  // 替换为您的 DocBase 访问令牌
        "DOCBASE_TEAM_NAME": "your-team-name"     // 替换为您的 DocBase 团队域名
      }
    }
  }
}

配置参数说明:

'server name': 'docbase-mcp-server' - 服务器名称，用于在客户端中标识和引用。
'command': '/path/to/docbase-mcp-server/build/index.js' - 需要替换为 'docbase-mcp-server' 构建后 'index.js' 文件的绝对路径。 指向服务器启动脚本的命令。
'args': '[]' - 启动命令的参数，当前配置为空数组。
'environment': 环境变量配置。
- 'DOCBASE_ACCESS_TOKEN': 需要替换为您的 DocBase 个人访问令牌。 用于访问 DocBase API 的身份验证。
- 'DOCBASE_TEAM_NAME': 需要替换为您的 DocBase 团队域名。 指定要访问的 DocBase 团队。

WSL (Windows Subsystem for Linux) 环境配置示例:

如果您在 WSL 环境中使用，可以参考以下配置：

{
  "mcpServers": {
    "docbase-mcp-server": {
      "command": "wsl",
      "args": [
        "node",
        "/path/to/docbase-mcp-server/build/index.js"
      ],
      "environment": {
        "DOCBASE_ACCESS_TOKEN": "your-access-token",  // 替换为您的 DocBase 访问令牌
        "DOCBASE_TEAM_NAME": "your-team-name"     // 替换为您的 DocBase 团队域名
      }
    }
  }
}

WSL 配置参数说明:

'command': 'wsl' - 使用 WSL 命令来执行后续操作。
'args': '["node", "/path/to/docbase-mcp-server/build/index.js"]' - 在 WSL 环境中执行 Node.js 启动 'index.js' 脚本。 同样需要替换 '/path/to/docbase-mcp-server/build/index.js' 为实际路径。
'environment': 环境变量配置与非 WSL 环境相同。

基本使用方法

确保已按照安装步骤完成安装和构建。
根据您的操作系统和环境，配置 MCP 客户端 (如 Claude Desktop) 的 'claude_desktop_config.json' 文件，填入正确的 'command' 路径、DocBase 访问令牌和团队域名。
启动 MCP 客户端。客户端应该能够检测到 'docbase-mcp-server' 并加载 'docbase-posts-search' 工具。
在 MCP 客户端中，当需要搜索 DocBase 文章时，客户端会调用 'docbase-posts-search' 工具，并允许您输入搜索关键词。
服务器会将搜索请求发送到 DocBase API，并将结果返回给客户端。

注意: 目前该 MCP 服务器仅实现了 'docbase-posts-search' 工具，资源 (Resources) 和 Prompt 模板 (Prompts) 功能尚未实现。

关键词