ShowDoc MCP 集成指南

slc2006119

160人浏览 · 2026-08-20 11:56:01

slc2006119 · 2026-08-20 11:56:01 发布

让 AI 编辑器直接操作你的 ShowDoc 文档

ShowDoc一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册https://www.showdoc.com.cn/help/11559060626714585

这是什么？

MCP（Model Context Protocol）是一种让 AI 编辑器与 ShowDoc 交互的协议。简单来说，它让你的 AI 助手能够：

📖 读取你的 ShowDoc 文档内容
✏️ 创建和编辑文档
🔍 搜索文档内容
📁 管理项目、目录和附件

有什么用？

场景一：让 AI 帮你写文档

你只需要用自然语言告诉 AI：”帮我创建一个用户登录接口的文档”，AI 就会自动在 ShowDoc 中创建好文档，包含接口地址、参数说明、返回示例等完整内容。

场景二：让 AI 帮你维护文档

当你的代码发生变化时，可以让 AI 自动更新对应的接口文档，保持文档与代码同步。

场景三：批量操作

需要批量导入 OpenAPI/Swagger 文档？或者批量更新多个页面？AI 可以一次性帮你完成。

如何配置？

第一步：获取 AI 令牌

登录你的 ShowDoc 网站
进入「用户中心」→「令牌管理」
点击「创建令牌」
根据需要设置令牌权限：
- 只读：AI 只能读取文档，不能修改
- 读写：AI 可以读取和修改文档
- 权限范围：可以选择让 AI 访问所有项目，或仅访问指定项目

复制生成的令牌（以 ai_ 开头）

⚠️ 安全提示：令牌相当于你的登录凭证，请妥善保管，不要泄露给他人。

第二步：在 AI 编辑器中配置

ShowDoc MCP 采用标准的 HTTP 协议，支持任何兼容 MCP 的 AI 编辑器。配置时需要以下信息：

配置项	值
服务类型	streamable-http (某些工具的服务类型取值是 http ，建议两个都试下)
服务地址	见下方说明
认证方式	Bearer Token
令牌	你在第一步中获取的 `ai_` 开头的令牌

服务地址说明：

ShowDoc 官网用户：https://www.showdoc.cc/mcp.php
私有部署用户：https://你的showdoc地址/mcp.php

通用配置格式

大多数 AI 编辑器的 MCP 配置都是 JSON 格式，核心字段如下：

{
  "mcpServers": {
    "showdoc": {
      "type": "streamable-http", // 某些工具 type 的取值是 http  ，建议两个都试下
      "url": "https://www.showdoc.cc/mcp.php",
      "headers": {
        "Authorization": "Bearer 你的AI令牌"
      }
    }
  }
}

配置位置

不同 AI 编辑器的配置文件位置不同，请参考你所使用编辑器的官方文档：

编辑器	配置位置
Cursor	设置 → MCP / Model Context Protocol
VS Code + Cline	Cline 扩展设置 → MCP Servers
Claude Desktop	配置文件 `~/.claude.json`
其他	搜索「编辑器名称 + MCP 配置」

第三步：开始使用

配置完成后，重启 AI 编辑器，然后就可以直接与 AI 对话了。例如：

“列出我的所有 ShowDoc 项目”
“在某某项目中搜索包含’登录’的文档”
“帮我创建一个新文档，标题是xxx，内容是xxx”

常见使用示例

示例 1：查看项目列表

用户：列出我在 ShowDoc 中的所有项目


AI：我来查询你的项目列表...
   你有以下项目：
   1. 电商平台 API 文档
   2. 内部管理系统文档
   3. 移动端接口文档

示例 2：搜索文档

用户：帮我找一下关于"支付"的文档


AI：正在搜索...
   找到以下相关文档：
   1. 【电商平台 API 文档】支付接口说明
   2. 【电商平台 API 文档】支付回调处理
   3. 【内部管理系统文档】支付配置说明

示例 3：创建文档

用户：在"电商平台 API 文档"项目中创建一个新文档，标题是"购物车接口"，内容包含添加商品、删除商品、查看购物车三个接口


AI：好的，我来创建这个文档...
   已创建文档《购物车接口》，包含以下内容：
   - 添加商品到购物车接口
   - 删除购物车商品接口
   - 获取购物车列表接口

示例 4：导入 OpenAPI 文档

用户：帮我导入这个 OpenAPI 文档到 ShowDoc：https://example.com/openapi.json


AI：正在解析并导入...
   已成功导入 15 个接口文档，创建了 3 个目录分类

令牌权限说明

创建 AI 令牌时，你可以精细控制 AI 的操作权限：

权限设置	说明
只读	AI 只能查看文档，适合只需要查询信息的场景
读写	AI 可以创建、编辑、删除文档
全部项目	AI 可以访问你有权限的所有项目
指定项目	AI 只能访问你选择的特定项目
允许创建项目	AI 是否可以创建新项目
允许删除项目	AI 是否可以删除项目（默认关闭）