The Apidog MCP Server enables AI-powered IDEs like Cursor to directly access and work with your API specifications, accelerating development and streamlining your workflow.The Apidog MCP Server is currently in beta. This documentation will be updated regularly with new features and improvements.
What Can You Do with Apidog MCP Server?#
With Apidog MCP Server, AI assistants can:Generate code based on your API specifications
Search and query API specification content
Update DTOs with new fields from specifications
Add documentation comments to code based on API specs
Create complete MVC code for specific endpoints
How It Works#
Once configured, Apidog MCP Server automatically reads and caches all API specification data locally. The AI can then seamlessly retrieve and utilize this data.Simply tell the AI what you want to accomplish. For example:"Use MCP to fetch the API specification and generate Java records for the 'Product' schema and related schemas"
"Based on the API specification, add the new fields to the 'Product' DTO"
"Add comments for each field in the 'Product' class based on the API specification"
"Generate all the MVC code related to the endpoint '/users' according to the API specification"
API specifications are cached locally. If data in Apidog changes, ask the AI to refresh to ensure it reads the latest updates.
Prerequisites#
Before setting up Apidog MCP Server, ensure you have:Node.js (version 18 or later, preferably the latest LTS version)
Other MCP-supported editors
Choosing Your Data Source#
Apidog MCP Server supports three different data sources. Select the configuration method that matches your needs:Best for:Accessing API specifications within your Apidog team
Private or internal API development
Apidog personal API access token
On-Premise Deployment Configuration#
For on-premise deployments, add your server's API address to the configuration regardless of which data source you choose:{
"mcpServers": {
"API specification": {
"command": "npx",
"args": [
"-y",
"apidog-mcp-server@latest",
"--apidog-api-base-url=<your-server-url>"
]
}
}
}
<your-server-url> with your on-premise server's API address (starting with http:// or https://).Ensure your environment can access www.npmjs.com properly.
Help and Support#
The Apidog MCP Server is currently in beta. We'd love to hear your feedback and suggestions!
