Apifox MCP Server

🚀 Apifox MCP Server

The Apifox MCP Server allows you to provide the interface documentation from your Apifox projects as a data source to AI - powered programming IDEs like Cursor. This enables AI to directly access the corresponding interface documentation data of your projects.

Developers can use the AI assistant to perform tasks such as generating or modifying code based on the interface documentation, and searching the content of the interface documentation. As for what more powerful things the AI can do with this interface documentation data, feel free to unleash your imagination and your team's creativity!

🚀 Quick Start

After installing and configuring MCP, the Apifox MCP Server will automatically read all the interface documentation data from your entire Apifox project and cache it on your local computer. The AI can then read all the interface documentation data within the project through MCP.

All you need to do is tell the AI what task you want to accomplish using the API documentation. Here are some examples:

1. "Retrieve the API documentation via MCP and generate the definition code for the Product and its related models."
2. "Add several newly added fields to the Product DTO according to the API documentation."
3. "Add comments to each field of the Product class based on the API documentation."
4. "Generate all the MVC code related to the /users interface according to the API documentation."

Note: The interface documentation data is cached locally by default. If there are updates to the data in Apifox, please remind the AI to refresh the interface documentation data; otherwise, the data read by the AI may not be the latest.

📦 Installation

Prerequisites

• Node.js environment installed (version >= 18, it is recommended to use the latest LTS version).
• At least one IDE that supports MCP:
  • Cursor
  • VSCode + Cline plugin

Installation Steps

1. Generate an Access Token in Apifox a. Open Apifox, hover your mouse over the avatar in the upper - right corner of the page, and click "Account Settings -> API Access Tokens". b. Create a new API access token. For specific operations, please refer to the help documentation. c. After obtaining the API access token, replace <access - token> in the following configuration file.

2. Get the Apifox Project ID a. Open the corresponding project in Apifox. b. Click "Project Settings" in the left sidebar, and view the project ID in "Basic Settings". c. Replace <project - id> in the following configuration file with the project ID.

3. Installation and Configuration

   • For most cases, run the following command:

     npm install -g apifox-mcp-server
     

     Then, start the server by running the following command as needed:

     apifox-mcp-server --project-id=<your-project-id>
     

   • If you need to use private deployment, add the --apifox-api-base-url parameter to specify the address of the Apifox service.

4. Directly Read Swagger/OAS Files

   If you don't use an Apifox project, you can directly specify a Swagger or OpenAPI documentation file:

   apifox-mcp-server --oas https://example.com/swagger.json
   

❓ Help and Support

The Apifox MCP Server is currently in the internal testing phase. We welcome your suggestions and ideas. Please contact us in the following way: