项目简介

DocBase MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 LLM 应用提供访问 DocBase 文档知识库的能力。通过此服务器,LLM 可以利用预定义的工具,安全、便捷地从 DocBase 获取文章信息。

主要功能点

  • 获取文章列表 (get_posts): 允许 LLM 根据关键词搜索 DocBase 中的文章,支持丰富的搜索语法。
  • 获取文章详情 (get_post): 允许 LLM 根据文章 ID 获取指定文章的详细内容。

安装步骤

由于该 MCP 服务器以 npm 包的形式发布,因此无需手动下载仓库代码。您只需在 MCP 客户端环境中配置该服务器的启动信息即可。

服务器配置

以下 JSON 配置信息用于 MCP 客户端配置 'docbase-mcp-server' 服务器。客户端将使用此配置启动服务器进程并与之通信。

{
  "mcpServers": {
    "docbase-mcp-server": {
      "command": "npx",  // 启动命令,使用 npx 执行 npm 包
      "args": [
        "-y",             // npx 参数,自动确认安装包
        "@f440/docbase-mcp-server" // 要执行的 npm 包名,即 DocBase MCP Server
      ],
      "env": {
        "DOMAIN": "<YOUR_DOMAIN>", // DocBase 团队域名,例如 myteam (对于 myteam.docbase.io)
        "TOKEN": "<YOUR_TOKEN>"  // DocBase API 访问令牌,需在 DocBase 设置中生成
      }
    }
  }
}

请务必替换 '<YOUR_DOMAIN>' 和 '<YOUR_TOKEN>' 为您真实的 DocBase 团队域名和 API 访问令牌。 获取 'DOMAIN' 和 'TOKEN' 的步骤请参考 README.md 中的说明。

基本使用方法

在 MCP 客户端中配置并启动 'docbase-mcp-server' 后,您可以使用 'get_posts' 和 'get_post' 这两个工具。

  • 'get_posts' 工具允许您通过关键词搜索 DocBase 文章。例如,您可以指示 LLM 使用 'get_posts' 工具,并提供搜索关键词来查找相关文档。
  • 'get_post' 工具允许您通过文章 ID 获取特定文章的详细内容。例如,如果已知文章 ID,可以使用此工具获取文章的具体信息。

具体工具的使用方法和参数,请参考仓库 README.md 或工具的描述信息。

信息

分类

数据库与文件