Overview
What is apifox-mcp?
apifox-mcp is a TypeScript implementation of the Model Context Protocol (MCP) that runs over stdio and provides access to Apifox API data. It allows AI assistants to fetch detailed API endpoint definitions directly from the Apifox platform.
How to use apifox-mcp?
Install the npm package (@juzi965/apifox-mcp-server) and configure it as an MCP server in your environment (e.g., Cursor). Set the required APIFOX_AUTH environment variable with your Apifox authentication token. The server exposes a single tool, get_api_endpoint_info, which accepts projectId and endpointId as parameters.
Key features of apifox-mcp
- Exposes one tool:
get_api_endpoint_info - Retrieves full API endpoint definitions from Apifox
- Returns request headers, method, request/response parameters, and response headers
- Communicates via stdio (standard input/output)
- Requires only an Apifox authentication token for setup
Use cases of apifox-mcp
- AI assistant queries an API’s endpoint details to generate client code
- Developer asks for the request/response structure of an Apifox-managed API
- Automating documentation updates by fetching API definitions on demand
FAQ from apifox-mcp
What does the server do?
It provides a Model Context Protocol server that retrieves detailed information about API endpoints stored in Apifox, including request parameters, headers, and response structure.
What tool does the server expose?
The server exposes one tool called get_api_endpoint_info, which requires projectId and endpointId as mandatory parameters.
How do I set up authentication?
Set the APIFOX_AUTH environment variable with your Apifox authentication token. This token is required for the server to access Apifox API data.
How can I debug the server?
Because the MCP server communicates over stdio, debugging can be tricky. The README recommends using the MCP Inspector via npm run inspector, which provides a browser-based debugging interface.
What are the runtime requirements?
The server is a Node.js TypeScript project. You need Node.js installed, and you run it with npx or after building the project locally with npm run build. No other third-party dependencies beyond the MCP protocol libraries are mentioned.
