Apifox 帮助文档
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. API 调试
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入(绑定数据源)
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 接口设计规范
    • 模块
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 接口评论
    • 批量管理
    • 通用接口文档
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 数据模型
      • 高级数据类型
      • 构建数据模型
      • 概述
      • 通过 JSON 等生成
      • 新建数据模型
      • 数据模型进阶
        • 使用 oneOf / anyOf / allOf 构建组合模式
        • 使用 discriminator 实现多态数据结构
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口调试用例
    • 接口测试用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 环境管理
      • 全局/环境/模块/临时变量
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • SSE 调试
      • MCP 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SOAP/WebService
      • gRPC 调试
      • Webhook 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试套件
      • 概述
      • 新建测试套件
      • 编排测试套件
      • 本地运行测试套件
      • CLI 运行测试套件
      • 定时任务
    • 测试报告
      • 测试报告
    • API 测试
      • 性能测试
      • 集成测试
      • 端到端测试
      • 回归测试
      • 契约测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Gitlab 集成
      • 与其它更多 CI/CD 平台集成
      • 与 Jenkins 集成
      • Git 提交自动触发测试
      • 与 Github Actions 集成
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义页面代码
    • 自定义域名
    • AI 相关特性
    • SEO 设置
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 功能简介
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 基本概念
    • 团队入驻
    • 管理团队
      • 团队基本操作
      • 成员角色与权限设置
      • 团队成员管理
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent(Proxy)
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
        • Git 仓库连接
    • 管理组织
      • 组织基本操作
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
      • 订单管理
        • 组织付费经理
  • 离线空间
    • 功能简介
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox AI 功能
    • 总览
    • 启用 AI 功能
    • 生成测试用例
    • 修改数据模型
    • 接口规范性检测
    • 接口文档完整性检测
    • 字段命名
    • 常见问题
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
    • Apifox 测试步骤之间怎么传递数据?
  • 账号&应用设置
    • 账号设置
    • API 访问令牌
    • 通知
    • 语言设置
    • 快捷键
    • 网络代理
    • 数据备份与恢复
    • 更新 Apifox
    • 实验性功能
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. API 调试

MCP 调试

Apifox 版本需 ≥2.8.3
如果你要在 AI 编程工具里使用 MCP 获取 Apifox 项目内的接口数据,可以移步 Apifox MCP Server 文档

概览#

MCP(Model Context Protocol)是一个开放协议,用于在大语言模型(LLM)应用与外部数据源和工具之间建立标准化通信。你可以在 Apifox 中创建 MCP 客户端,以调试和测试 MCP 服务端。
MCP 服务端提供三大核心功能,Apifox MCP 客户端均支持对其进行调试:
Tools:可在服务端执行的函数
Resources:服务端提供的数据资源
Prompts:预定义的提示词模板
支持两种传输方式:
STDIO:通过标准输入/输出进行通信,适用于本地进程
HTTP:通过可流式传输的 HTTP(Streamable HTTP)进行通信,适用于远程服务端
请使用 Web 版或从官网首页下载最新版本的桌面版。

新建 MCP 客户端#

在 HTTP 项目中新建一个接口,并选择 MCP。
新建 MCP 客户端

连接 MCP 服务端#

输入服务端地址#

Apifox 支持多种方式输入 MCP 服务端连接信息:
直接输入命令或 URL
粘贴终端命令时,协议会自动切换为 STDIO:
粘贴 URL 时,协议会自动切换为 HTTP:
https://example-server.modelcontextprotocol.io/mcp
粘贴配置文件
Apifox 支持直接粘贴 MCP 服务端配置文件,并会自动解析并填充相关信息。
MCP Servers 文件示例:
{
  "mcpServers": {
    "Everything Server": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-everything"],
      "env": {}
    }
  }
}
MCP Server 条目示例:
{
  "type": "streamable-http",
  "url": "https://example-server.modelcontextprotocol.io/mcp"
}
粘贴配置文件后,Apifox 会自动提取服务端名称、地址、环境变量等信息。如果配置文件包含多个服务端,将使用第一个。

建立连接#

点击连接按钮发起连接。
STDIO 连接
由于需要执行本地命令,Apifox 会显示安全确认对话框。确认后,将启动本地进程并建立连接。
HTTP 连接
直接向指定的 URL 发送连接请求。
对于支持 OAuth 2.0 鉴权的 MCP 服务端,Apifox 会自动获取鉴权配置并显示鉴权窗口
其他鉴权方式(API Key、Bearer Token、Basic Auth 等)也可以在 Auth 标签页中手动配置
连接成功后,目录树将显示该服务端提供的 Tools、Resources 和 Prompts 列表。

调试功能#

Tools#

Tools 是服务端提供的可执行函数。选择某个 Tool 后,你可以通过表单或 JSON 编辑器配置参数。
配置参数后,点击运行即可执行。结果将显示在响应区域。
CleanShot 2026-01-27 at 15.24.42@2x.png

Resources#

Resources 是服务端提供的数据资源。选择某个 Resource 后,点击运行即可获取资源内容。
CleanShot 2026-01-27 at 15.25.12@2x.png

Prompts#

Prompts 是预定义的提示词模板。选择某个 Prompt 后,配置参数(如有)并点击运行即可获取生成的提示词。
CleanShot 2026-01-27 at 15.26.24@2x.png

配置选项#

环境#

仅适用于 STDIO 模式。用于配置启动 MCP 服务端进程时的环境变量。
示例:
KeyValue
ACCESS_TOKENyour-token-here
NODE_ENVproduction

Auth#

仅适用于 HTTP 模式。支持多种鉴权方式:
API Key
Bearer Token
JWT Bearer
Basic Auth
Digest Auth
OAuth 2.0
对于支持 OAuth 2.0 的 MCP 服务端,Apifox 可以自动获取并填充鉴权配置。
CleanShot 2026-01-27 at 15.29.08@2x.png

Headers#

仅适用于 HTTP 模式。用于配置自定义 HTTP 请求 header。

查看响应#

响应区域分为两个标签页:
Messages:显示与用户操作相关的消息(连接/断开事件、请求/响应)
Notifications:显示服务端主动发送的消息(通知、工具列表更新等)
点击单条消息可查看详情,包括消息类型、内容、时间戳等。
你可以切换到 "包含信封" 模式来查看完整的 JSON-RPC 格式。
CleanShot 2026-01-27 at 15.32.43@2x.png

变量支持#

在以下位置支持使用变量 {{variable_name}}:
服务端地址或命令
环境变量值
请求 header
鉴权信息
参数值

保存与共享#

配置好的 MCP 客户端可以保存到项目中,以便后续使用和团队协作。
注意:MCP 目录树(Tools、Prompts、Resources 列表)仅存储在本地,并在每次连接时自动刷新。

常见问题#

STDIO 连接失败,提示 "command not found" 错误?#

请确保已安装所需的运行时(如 Node.js),并检查命令路径是否正确。

HTTP 连接返回 401 错误?#

Apifox 会自动尝试获取 OAuth 2.0 配置。如果失败,请在 Auth 标签页中手动配置鉴权信息。

连接成功但目录树为空?#

请检查服务端配置是否正确,并查看 Notifications 标签页以确认服务端是否返回了工具列表。

参数类型不匹配?#

使用表单模式时,Apifox 会自动校验参数类型。在 JSON 编辑器模式下,请注意不要给数字添加引号,布尔值请使用 true/false。
上一页
SSE 调试
下一页
GraphQL 调试
Built with