YAPI MCP Server
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@YAPI MCP Serverlist all my configured YAPI projects"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
YAPI MCP Server
English | 中文
A Model Context Protocol (MCP) server for YAPI - enabling AI assistants to manage API documentation.
Features
Tool | Description | YAPI API |
| List all configured projects | - |
| Run automated tests |
|
| Import API data |
|
| Add new interface |
|
| Save interface |
|
| Update interface |
|
| Get interface details |
|
| List interfaces |
|
| Get interface menu |
|
| Add interface category |
|
| Get all categories |
|
Installation
Clone the repository, then install dependencies and build in the project directory:
git clone <repo-url>
cd yapi-mcp
npm install
npm run buildConfiguration
Environment Variables
Variable | Required | Description |
| Yes | YAPI server URL, e.g., |
| Yes | Project configuration in format: |
YAPI_PROJECTS Format
projectId1:token1,projectId2:token2Example:
123:abc123token,456:def456tokenYou can get the project token from YAPI project settings page.
Usage with Cursor
Add to your Cursor MCP configuration file:
macOS/Linux
Edit ~/.cursor/mcp.json and replace /path/to/yapi-mcp with your actual project path:
{
"mcpServers": {
"yapi": {
"command": "node",
"args": ["/path/to/yapi-mcp/dist/index.js"],
"env": {
"YAPI_BASE_URL": "https://your-yapi-server.com",
"YAPI_PROJECTS": "123:your-token-here,456:another-token"
}
}
}
}Windows
Edit %APPDATA%\Cursor\mcp.json and use your actual project path (e.g. C:\\Users\\YourName\\yapi-mcp\\dist\\index.js):
{
"mcpServers": {
"yapi": {
"command": "node",
"args": ["C:\\path\\to\\yapi-mcp\\dist\\index.js"],
"env": {
"YAPI_BASE_URL": "https://your-yapi-server.com",
"YAPI_PROJECTS": "123:your-token-here"
}
}
}
}Usage with Claude Desktop
Add to your Claude Desktop configuration:
macOS
Edit ~/Library/Application Support/Claude/claude_desktop_config.json and replace /path/to/yapi-mcp with your actual project path:
{
"mcpServers": {
"yapi": {
"command": "node",
"args": ["/path/to/yapi-mcp/dist/index.js"],
"env": {
"YAPI_BASE_URL": "https://your-yapi-server.com",
"YAPI_PROJECTS": "123:your-token-here"
}
}
}
}Windows
Edit %APPDATA%\Claude\claude_desktop_config.json with the same configuration, using your actual project path.
Tool Examples
List All Projects
{
"name": "yapi_list_projects",
"arguments": {}
}Get Interface List (Default Project)
{
"name": "yapi_interface_list",
"arguments": {
"page": 1,
"limit": 20
}
}Get Interface List (Specific Project)
{
"name": "yapi_interface_list",
"arguments": {
"project": 456,
"page": 1,
"limit": 20
}
}Add New Interface
{
"name": "yapi_interface_add",
"arguments": {
"catid": 456,
"title": "Get User Info",
"path": "/api/user/info",
"method": "GET",
"desc": "Get user details by ID"
}
}Get Interface Details
{
"name": "yapi_interface_get",
"arguments": {
"id": 789
}
}Run Automated Tests
{
"name": "yapi_run_auto_test",
"arguments": {
"project": 456,
"env_name": "dev"
}
}Development
# Clone the repository
cd yapi-mcp
# Install dependencies
npm install
# Development mode
npm run dev
# Build
npm run build
# Run
npm startSecurity
Never commit your YAPI tokens to version control
Use environment variables to store sensitive configuration
Consider using a secrets manager for production deployments
License
MIT
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/zhhbinn/yapi-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server