ApiFox MCP Server

ApiFox MCP Server

site icon
2025.04.03 1
TypeScript接口管理开发辅助开发效率
ApiFox MCP Server 是一个基于 Model Context Protocol (MCP) 的接口服务器,主要用于获取和管理 ApiFox 的接口信息。通过在 Cursor 中配置 MCP 服务,可以获取对应接口模块信息并返回给大模型,帮助实现业务逻辑。该服务器支持 HTTP 服务和 CLI 命令行两种使用方式,使用 TypeScript 开发,提供类型安全,并支持环境变量配置。
View on GitHub

Overview

基本能力

产品定位

ApiFox MCP Server 是一个基于 Model Context Protocol (MCP) 的接口服务器,主要用于获取和管理 ApiFox 的接口信息,帮助开发者通过接口信息实现业务逻辑。

核心功能

  • 支持通过 MCP 协议获取 ApiFox 接口信息
  • 提供 HTTP 服务和 CLI 命令行两种使用方式
  • 使用 TypeScript 开发,提供类型安全
  • 支持环境变量配置

适用场景

  • 开发者需要快速获取和管理 ApiFox 接口信息
  • 通过接口信息辅助实现业务逻辑
  • 需要与 Cursor 集成以提升开发效率

工具列表

  • npx @wangmhaha/apifox-mcp-server@latest: 快速安装并运行 MCP 服务器
  • pnpm install: 安装依赖
  • pnpm build: 打包项目
  • pnpm start:http: 启动 HTTP 服务

常见问题解答

  • 如何配置环境变量? 在项目根目录下修改 .env.example 文件为 .env 文件,并配置 APIFOX_API_KEYPROJECT_ID 等环境变量。
  • 如何通过 CLI 运行? 使用 npx @wangmhaha/apifox-mcp-server@latest 命令并传入必要的参数。

使用教程

使用依赖

  • 确保已安装 Node.js 和 pnpm

安装教程

  1. 通过 npx 快速安装并运行: bash npx @wangmhaha/apifox-mcp-server@latest --apifox-api-key=<your-apifox-api-key> --project=<your-project-id>
  2. 或者从本地源运行: bash pnpm install pnpm build pnpm start:http

调试方式

  1. 启动服务后,可以通过以下命令检查服务是否正常运行: bash curl http://localhost:3000/sse
  2. 确保环境变量已正确配置,可以通过以下命令检查环境变量: bash echo $APIFOX_API_KEY echo $PROJECT_ID

许可证

该项目遵循 ISC 开源许可条款。