Apifox MCP

Apifox MCP

site icon
2025.03.14 0
TypeScriptAPI 文档集成AI 助手集成开发效率
mcp-apifox 是一个用于将 Apifox API 文档与 AI 助手集成的 Model Context Protocol (MCP) 服务器。它为 Apifox(一个 API 开发和测试平台)和支持 Model Context Protocol 的 AI 助手之间提供了桥梁,允许 AI 助手从 Apifox API 文档中提取信息,使开发过程中理解和使用 API 变得更加容易。
View on GitHub

Overview

基本能力

产品定位

mcp-apifox 是一个用于将 Apifox API 文档与 AI 助手集成的 MCP 服务器,旨在提升开发效率,简化 API 文档的使用和理解。

核心功能

  • 从 Apifox URL 中提取项目 ID 和 API ID
  • 使用提取的 ID 从 Apifox 获取详细的 API 信息
  • 与支持 MCP 的 AI 助手无缝集成

适用场景

  • 开发过程中需要快速理解和使用 API 文档的场景
  • AI 助手需要访问和解析 Apifox API 文档的场景
  • 团队协作中需要共享和统一 API 文档理解的场景

工具列表

1. get-apifox-project-id-and-api-id-from-url

从 Apifox URL 中提取项目 ID 和 API ID。

输入: - text:包含 Apifox URL 或路径的字符串

输出: - 包含 projectIdapiId 的 JSON 对象

2. get-apifox-api-info

从 Apifox 获取详细的 API 信息。

输入: - projectId:Apifox 项目 ID - apiId:Apifox API ID

输出: - 请求的 API 的 OpenAPI 规范

使用教程

使用依赖

  • 拥有访问令牌的 Apifox 账户
  • 支持 Model Context Protocol 的 AI 助手

安装教程

# 全局安装
npm install -g mcp-apifox

# 或使用 pnpm
pnpm add -g mcp-apifox

配置

方法一

{
  "mcpServers": {
    "apifox": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-apifox@latest"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": ""
      }
    }
  }
}

方法二

{
  "mcpServers": {
    "apifox": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-apifox@latest",
        "--token=xxxx"
      ]
    }
  }
}

使用

通过下面这种协作链接就可以获取接口信息,需要维护者权限

https://app.apifox.com/link/project/${projectId}/apis/api-${apiId}

调试方式

安装完成后,可以通过以下步骤进行调试:

  1. 确保 Apifox 访问令牌已正确配置
  2. 使用提供的工具进行 API 信息提取和获取
  3. 检查输出是否符合预期

许可证

None