Apifox MCP Server

🚀 ApiFox MCP Server

An ApiFox interface server based on the Model Context Protocol (MCP) for retrieving and managing ApiFox interface information. By configuring the MCP service in Cursor, you can obtain corresponding interface module information and return it to the large model, enabling Cursor to assist you in implementing business logic using the interface information.

✨ Features

• Support for retrieving ApiFox interface information via the MCP protocol.
• Available in two usage modes: HTTP service and CLI command line.
• Developed with TypeScript for type safety.
• Support for environment variable configuration.

🚀 Quick Start

📦 Installation

You can quickly install and run the server using the following command:

npx @wangmhaha/apifox-mcp-server@latest --apifox-api-key=<your-apifox-api-key> --project=<your-project-id>

💻 Usage Examples

Basic Usage

Configure Cursor to connect to the MCP server via SSE. The server will start on the configured port (default is 3000).

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
}

Advanced Usage

It is recommended to configure the apifox-mcp-server using a JSON configuration file. Add the following content to the Cursor MCP configuration file:

"apifox-mcp-server": {
    "command": "npx",
    "args": ["-y", "@wangmhaha/apifox-mcp-server@latest", "--local"],
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
}

Run from Local Source

If you prefer to run the server from the local source, follow these steps:

Install Dependencies

pnpm install

Build the Project

pnpm build

Start the Server

pnpm start:http

Configuration

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
}

You can also run the server in command mode:

"apifox-mcp-server": {
    "command": "node",
    "args": [
      "<you-local-path>/build/index.js",
      "--local",
    ],
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
},

Environment Variable Configuration

If you do not configure environment variables in the MCP configuration file, you can configure them in the local environment. Modify the .env.example file in the project root directory to .env and configure the following content:

APIFOX_API_KEY=your_api_key_here
PROJECT_ID=your_project-ID
PORT=3000  # Optional, default is 3000

🔧 Technical Details

The project is built on the following technology stack:

📄 License

This project is licensed under the ISC License.