将已发布的文档连接到 AI

Apidog MCP Server 使 AI 能够连接并使用由 Apidog 发布的在线 API 文档，让外部开发者和 AI 助手能够无缝访问公开 API 文档。

此配置方法仅支持公开发布的在线文档。不支持带有密码或允许列表设置的文档。

对于非公开文档，请改用 Apidog Project data source。

为在线文档启用 MCP

需要 Apidog 版本 2.7.2 或更高版本。

启用 MCP 服务

导航到你的 Apidog 项目

前往 Publish Docs → Publish Docs Sites → LLM-friendly Features

启用 MCP 服务

获取配置文件

启用 MCP 后，访问你的在线文档时将显示 MCP 按钮。

点击该按钮以显示配置指南和 MCP 配置文件，其中会自动包含你的文档 site-id。复制此配置以用于 IDE 集成。

配置 MCP 客户端

前提条件

在配置 MCP 客户端之前，请确保你已具备：

Node.js（版本 18 或更高，最好是最新的 LTS 版本）

一个兼容 MCP 的 IDE：

Cursor

VS Code + Cline plugin

其他支持 MCP 的编辑器

从 Apidog 在线文档中复制的 MCP JSON 配置

在 Cursor 中配置 MCP

打开 MCP 设置

打开 Cursor 编辑器

点击设置图标（右上角）

从左侧菜单中选择 MCP

点击 + Add new global MCP server

添加配置

将从在线文档中复制的 MCP JSON 配置粘贴到打开的 mcp.json 文件中：

macOS / Linux

Windows

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

验证配置

通过向 AI 提问（在 Agent 模式下）来测试连接：

Please fetch API documentation via MCP and tell me how many endpoints exist in the project.

如果 AI 返回正确的 API 信息，则表示连接成功。

重要说明

使用多个文档站点

要使用不同的 API 文档站点，请在配置文件中添加多个 MCP Server 配置。每个文档站点都应拥有自己唯一的 <site-id>。

私有化部署

对于私有化部署，请在 IDE MCP 配置中包含你的服务器 API 地址：

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

将 <your-server-url> 替换为你的私有化服务器 API 地址（以 http:// 或 https:// 开头）。确保能够访问 www.npmjs.com 网络。

其他数据源

将 Apidog 项目内的 API 规范连接到 AI

将 OpenAPI 文件连接到 AI

常见问题

Windows 配置问题

如果标准配置在 Windows 上失败，请使用以下替代方案：

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Node.js 版本问题

如何让 AI 从更新后的 API 文档中读取最新数据？

将已发布的文档连接到 AI

为在线文档启用 MCP#

配置 MCP 客户端#

前提条件#

在 Cursor 中配置 MCP#

重要说明#

使用多个文档站点#

私有化部署#

其他数据源#

常见问题#

为在线文档启用 MCP

配置 MCP 客户端

前提条件

在 Cursor 中配置 MCP

重要说明

使用多个文档站点

私有化部署

其他数据源

常见问题