Apifox MCP Server

A Model Context Protocol (MCP) server for Apifox API management with read/write/import capabilities, based on Apifox Open API.

Features

Read Operations

• apifox_get_project - Get project details

• apifox_get_folders - Get folder list (directory structure)

• apifox_get_endpoints - Get API endpoint list

• apifox_get_endpoint - Get endpoint details

• apifox_get_schemas - Get data model list

• apifox_export_openapi - Export as OpenAPI format

Write Operations

• apifox_create_folder - Create folder

• apifox_create_endpoint - Create API endpoint

• apifox_update_endpoint - Update API endpoint

• apifox_delete_endpoint - Delete API endpoint

• apifox_create_schema - Create data model

Import Operations

• apifox_import_openapi - Import OpenAPI/Swagger data

• apifox_import_openapi_from_url - Import OpenAPI data from URL

Installation

From npm

npm install -g apifox-mcp-server

From source

git clone https://github.com/lishuji/apifox-mcp-server.git
cd apifox-mcp-server
npm install
npm run build

Configuration

1. Get API Access Token

1. Login to Apifox

2. Click avatar in top right → Account Settings

3. Click "API Access Token" → Create new token

4. Save the generated token

2. Get Project ID

1. Open your Apifox project

2. The number in the project URL is the project ID, e.g., 4051641 in https://apifox.com/project/4051641

3. Configure MCP Client

Add to your MCP client configuration (e.g., ~/.codebuddy/mcp.json for CodeBuddy):

{
  "mcpServers": {
    "Apifox": {
      "command": "npx",
      "args": [
        "apifox-mcp-server",
        "--project=YOUR_PROJECT_ID"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "YOUR_ACCESS_TOKEN"
      }
    }
  }
}

Or if installed globally:

{
  "mcpServers": {
    "Apifox": {
      "command": "apifox-mcp-server",
      "args": [
        "--project=YOUR_PROJECT_ID"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "YOUR_ACCESS_TOKEN"
      }
    }
  }
}

Usage Examples

Import OpenAPI Data

// Read local OpenAPI file content
const spec = fs.readFileSync('openapi.yaml', 'utf-8');

// Call import tool
apifox_import_openapi({
  spec: spec,
  targetFolderId: 12345,  // Target folder ID
  coverExistApi: true,    // Overwrite existing APIs
  syncFolder: true        // Sync folder structure
});

Create Endpoint

apifox_create_endpoint({
  name: "Get User List",
  method: "GET",
  path: "/api/v1/users",
  folderId: 12345,
  description: "Paginated user list",
  tags: ["User Management"]
});

Create Folder

apifox_create_folder({
  name: "User APIs",
  parentId: 0  // 0 means root directory
});

API Reference

apifox_import_openapi

Import OpenAPI/Swagger specification data.

Parameters:

apifox_create_endpoint

Create a new API endpoint.

Parameters:

Notes

1. API Version: Uses X-Apifox-Api-Version: 2024-03-28 header

2. Authentication: Bearer Token authentication

3. Rate Limiting: Be aware of Apifox API rate limits

4. Permissions: Ensure token has sufficient project operation permissions

Related Links

• Apifox Open API Documentation

• Apifox Help Documentation

• MCP Protocol Documentation

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.