Apifox

🚀 Apifox MCP Server

This project serves as a bridge between Apifox (an API development and testing platform) and AI assistants supporting the Model Context Protocol (MCP). It enables AI assistants to extract information from Apifox's API documentation, making it easier to understand and use APIs during development.

✨ Features

• Extract project ID and API ID from Apifox URLs.
• Retrieve detailed API information from Apifox using the extracted IDs.
• Seamlessly integrate with AI assistants supporting the MCP protocol.

📋 Prerequisites

• An Apifox account with an access token.
• An AI assistant supporting the Model Context Protocol.

📦 Installation

# Global installation
npm install -g mcp-apifox

# Or use pnpm
pnpm add -g mcp-apifox

⚙️ Configuration

Method 1

Add the following content to the configuration file:

{
  "mcpServers": {
    "apifox": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-apifox@latest"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": ""
      }
    }
  }
}

Method 2

Another way to configure is as follows:

{
  "mcpServers": {
    "apifox": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-apifox@latest",
        "--token=xxxx"
      ]
    }
  }
}

💻 Usage Examples

You can obtain interface information through the collaboration link. You need to have maintainer permissions:

https://app.apifox.com/link/project/${projectId}/apis/api-${apiId}

Available Tools

Tool 1: get-apifox-project-id-and-api-id-from-url

Function: Extract the project ID and API ID from an Apifox URL. Input:

• text: A string containing an Apifox URL or path. Output:
• A JSON object containing projectId and apiId.

Tool 2: get-apifox-api-info

Function: Retrieve detailed API information from Apifox. Input:

• projectId: Apifox project ID.
• apiId: Apifox API ID. Output:
• The OpenAPI specification of the requested API.