mcpField
A
apifox-mcp MCP 服务器

apifox-mcp MCP 服务器

本地服务
github.com/Juzisuan965开发工具555 周前更新

关于 apifox-mcp MCP 服务器

Apifox MCP Server 将 AI 助手连接到 Apifox 项目中的 API 定义,并返回结构化接口规约,涵盖请求参数和响应结构。

主要功能

  1. 01获取接口定义
  2. 02返回 HTTP 方法和请求头
  3. 03提供路径、查询及请求体参数
  4. 04包含响应体结构

适用场景

  1. 01编码时查看接口信息
  2. 02根据接口生成 TypeScript 入参与出参类型
  3. 03依据规约编写接口调用方法

MCP 相关

该 stdio MCP 服务向客户端提供接口信息工具,根据 Apifox 项目 ID 和接口 ID 获取 API 规约。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"apifox": {
"command": "npx",
"args": [
"-y",
"@juzi965/apifox-mcp-server"
],
"env": {
"APIFOX_AUTH": "<APIFOX_AUTH>"
}
}
}
}
启动命令npx -y @juzi965/apifox-mcp-server
需要配置的环境变量
APIFOX_AUTH密钥

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npm@juzi965/apifox-mcp-server

工具

1

收录的工具列表 · 更新于 3 周前

参数类型必填说明
projectIdnumber是Apifox 项目 ID
endpointIdnumber是接口 Endpoint 的 ID

详细介绍

来自项目 README

Apifox MCP Server

npm version

一个基于 Stdio 实现的模型上下文协议 (Model Context Protocol) 服务器,旨在无缝桥接 AI 助手与 Apifox 平台的 API 数据。

允许 AI 助手通过标准化的协议直接、实时地获取和理解您在 Apifox 项目中定义的 API 接口详情,从而显著提升开发效率和代码生成质量。

✨ 功能特性

工具
  • get_api_endpoint_info - 获取 Apifox 的接口定义信息
    • 请求参数
      • projectId: Apifox 项目的唯一标识符。
      • endpointId: 目标 API 端点的唯一标识符。
    • 返回数据
      • 一个结构化的 JSON 对象,包含完整的 API 规约 (Specification),例如:
        • HTTP 请求方法 (Method)
        • 求头 (Request Headers)
        • 路径、查询及请求体参数 (Parameters: Path, Query, Body)
        • 响应体结构 (Response Body Schema)
        • 响应头 (Response Headers)

🚀 安装配置

要在 Cursor 中使用此服务器,请添加以下服务器配置:

{
  "mcpServers": {
    "Apifox-MCP": {
      "command": "npx",
      "args": ["@juzi965/apifox-mcp-server"],
      "env": {
        "APIFOX_AUTH": "..."
      }
    }
  }
}
环境变量

该服务器需要以下环境变量:

  • APIFOX_AUTH: Apifox 的认证令牌

💡 使用方法

image

复制协作链接到 Cursor 中,让它帮你完成

  • 入参的 TS 类型定义
  • 出参的 TS 类型定义
  • 接口调用方法的定义 Xnip2025-06-19_14-30-13

🛠️ 调试

由于 MCP 服务器通过标准输入输出(stdio)通信,调试可能比较困难。我们推荐使用MCP Inspector,可通过以下命令启动:

npm run inspector

Inspector 将提供一个 URL,可在浏览器中访问调试工具。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。