关键词

Docbase知识库文档管理LLM知识检索

Docbase MCP Server 使用说明

项目简介

Docbase MCP Server 是一个 MCP (Model Context Protocol) 服务器，它允许 LLM (大型语言模型) 应用通过标准的 MCP 协议与 Docbase 知识库进行交互。通过该服务器，LLM 应用可以方便地利用 Docbase 存储的知识内容，扩展自身的功能。

主要功能点

  • 搜索 Docbase 文章 (Search Posts): 允许 LLM 应用根据关键词在 Docbase 知识库中搜索文章。
  • 获取 Docbase 文章详情 (Get Post): 允许 LLM 应用根据文章 ID 获取 Docbase 文章的完整内容。
  • 创建 Docbase 文章 (Create Post): 允许 LLM 应用在 Docbase 知识库中创建新的文章。
  • 更新 Docbase 文章 (Update Post): 允许 LLM 应用更新 Docbase 知识库中已有的文章。
  • 为 Docbase 文章添加评论 (Create Comment): 允许 LLM 应用为 Docbase 知识库中的文章添加评论。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/shogo-ma/docbase-mcp-server.git
cd docbase-mcp-server
  2. 编译服务器: 确保你已经安装了 Go 语言环境。执行以下命令编译服务器： 
    go build -o docbase-mcp-server
    这将在当前目录下生成可执行文件 'docbase-mcp-server'。

服务器配置

MCP 客户端（例如 Cursor 编辑器）需要配置才能连接到 Docbase MCP Server。配置信息通常在客户端的配置文件中指定（例如 '.cursor/mcp.json'）。

以下是一个典型的 '.cursor/mcp.json' 配置文件示例，你需要根据你的实际情况进行修改：

{
    "mcpServers": {
        "docbase-mcp-server": {
            "command": "your build path/docbase-mcp-server"  //  将 "your build path" 替换为 docbase-mcp-server 可执行文件的实际路径
        },
        "env": {
            "DOCBASE_API_DOMAIN": "your docbase domain",    //  替换为你的 Docbase 域名，例如 "example.docbase.io"
            "DOCBASE_API_TOKEN": "your api key"           //  替换为你的 Docbase API 访问令牌
        }
    }
}

配置参数说明:

  • 'mcpServers': 定义可用的 MCP 服务器。
    • 'docbase-mcp-server': 为该 MCP 服务器自定义的名称，在客户端中引用时使用。
      • 'command': 必填。指向 'docbase-mcp-server' 可执行文件的绝对或相对路径。请根据你的编译输出路径进行修改。
      • 'env': 必填。 环境变量配置，用于 Docbase API 的访问认证。
        • 'DOCBASE_API_DOMAIN': 必填。你的 Docbase 域名。
        • 'DOCBASE_API_TOKEN': 必填。你的 Docbase API 令牌。你需要在 Docbase 后台获取 API 令牌。

重要提示:

  • 请确保 'docbase-mcp-server' 可执行文件具有执行权限。
  • 'DOCBASE_API_DOMAIN' 和 'DOCBASE_API_TOKEN' 是连接 Docbase API 的凭证，请妥善保管，避免泄露。

基本使用方法

配置完成后，在支持 MCP 协议的客户端中，你可以通过以下工具与 Docbase MCP Server 交互：

  • search_posts: 搜索 Docbase 文章。需要提供 'query' 参数 (搜索关键词)，可选参数 'page' (页码) 和 'per_page' (每页数量)。
  • get_post_by_post_id: 获取指定 ID 的 Docbase 文章。需要提供 'post_id' 参数 (文章 ID)。
  • create_post: 创建新的 Docbase 文章。需要提供 'title' (标题) 和 'body' (内容) 参数，可选参数包括 'draft' (是否为草稿), 'notice' (是否发送通知), 'tags' (标签列表), 'scope' (文章 scope), 'groups' (分组ID列表)。
  • update_post: 更新已有的 Docbase 文章。需要提供 'post_id' (文章 ID)，以及需要更新的字段，例如 'title', 'body', 'draft', 'notice', 'tags', 'scope', 'groups' 等。
  • create_comment: 为 Docbase 文章添加评论。需要提供 'post_id' (文章 ID) 和 'body' (评论内容) 参数，可选参数 'notice' (是否发送通知)。

具体工具的使用方式和参数设置请参考 MCP 客户端的文档。通常，你可以在客户端中选择 'docbase-mcp-server' 这个 MCP 服务器，然后选择相应的工具并填写参数来调用 Docbase 的功能。

例如，在 Cursor 编辑器中，你可以使用 '@docbase-mcp-server search_posts query="关键词"' 来搜索 Docbase 文章。

信息

分类

数据库与文件

访问项目