read_project_oas_f7zfy0
Read the project's OpenAPI Spec file.
LABSCO SUMMARY
Client code stops being written against a stale copy of the spec.
The spec is pulled from the Apifox project on demand and refreshed on request, so an assistant writing a request body is reading the definition your team edits rather than a file committed months ago. $ref targets resolve through their own call, which keeps a spec that has been split across files fully readable.
What it is
Three tools over one Apifox project's OpenAPI Spec: read the spec, read the files its $ref entries point at, and re-download the latest copy from the server.
What you get
- The project's OpenAPI Spec read in full
- The files behind $ref entries fetched, several at a time by path
- The spec re-downloaded from the server when it has moved on
Requirements
An Apifox access token in APIFOX_ACCESS_TOKEN and the id of the project to read. npx on your PATH.
Setup effort
Add the configuration to your client
USE CASES
01
Writing client code against the API as it stands today
The spec is read from the Apifox project rather than from a copy in the repository, and $ref targets resolve through their own call so a split spec stays fully readable.
02
Picking up a spec change a teammate just published
Refresh pulls the current spec down from the server, so the next read reflects an edit made minutes ago rather than the copy fetched at startup.
3 tools
Counted once with only startup setup. Other versions, modes or optional credentials may expose a different list.
read_project_oas_ref_resources_f7zfy0
Read the files referenced by $ref inside the project's OpenAPI Spec; several can be fetched in one call.
refresh_project_oas_f7zfy0
Download the project's latest OpenAPI Spec from the server.
BEFORE YOU INSTALL
What to know first
Tools you get
3 tools when we connected. Tool names carry a per-instance suffix, so yours will end differently. Two tools read a project's OpenAPI spec and one refreshes the local cache; each configured project ID adds its own set of three.
Requires
APIFOX_ACCESS_TOKEN in your environment
Where it runs
All 4 documented setups run the server on your machine.
CONTEXT COST
Light Standing cost
Rated by the size of the 3 tool definitions that ride along on every turn, not by how many there are
INSTALLATION
Connect your client
MCP Clients
Cursor, Cline
JSON
{
"mcpServers": {
"API docs": {
"command": "npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--project-id=<YOUR_PROJECT_ID>"
],
"env": {
"APIFOX_ACCESS_TOKEN": "<YOUR_APIFOX_ACCESS_TOKEN>"
}
}
}
}Cursor — Windows, Cline — Windows
JSON
{
"mcpServers": {
"API docs": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"apifox-mcp-server@latest",
"--project-id=<YOUR_PROJECT_ID>"
],
"env": {
"APIFOX_ACCESS_TOKEN": "<YOUR_APIFOX_ACCESS_TOKEN>"
}
}
}
}
