YAPI MCP PRO acts as a smart bridge between the YApi interface management platform and AI-powered coding tools like Cursor or Claude. In the simplest terms, it gives an AI assistant the ability to "read" and "understand" a team's API documentation directly. Instead of a developer manually switching between a browser and their code editor to look up endpoint URLs or data structures, they can simply ask the AI to find the right interface for them. As developers move into more complex tasks, this tool becomes an essential part of the workflow by providing the AI with full context of the project’s backend architecture. It enables the AI to search through various projects, list available interfaces, and retrieve detailed user information. This deep integration allows the LLM to write more accurate code, generate precise mock data, and even help manage the entire lifecycle of an API without the developer ever leaving their development environment. On a technical level, the server is built on Node.js and utilizes the Model Context Protocol’s standard input/output (stdio) interface for seamless communication with AI editors. It simplifies authentication by using existing browser cookies, allowing for quick setup through environment variables like the YApi base URL and security tokens. By exposing these capabilities to an LLM, the tool effectively transforms static API documentation into a dynamic, searchable, and actionable resource that the AI can use to automate repetitive integration tasks.
Category: CRM, ERP & E-commerce
Tags: api-documentation, backend, interface-management, node-js, yapi
npx, meaning no permanent local installation is required, and it stays updated automatically. Requirements: * Node.js: version 16.0.0 or higher (18.0.0+ recommended). * npm: version 7.0.0 or higher. Verification Command: To ensure your environment is ready, run: bash npx yapi-mcp-pro --version Note: If you encounter connection issues, clear your npm cache first: bash npm cache clean --force ---http://your-yapi-server.com). 2. YAPI_TOKEN: Your browser cookie string (must include _yapi_token and _yapi_uid)..cursor/mcp.json in your project root and add: json { "mcpServers": { "yapi-mcp-pro": { "command": "npx", "args": ["-y", "yapi-mcp-pro"], "env": { "YAPI_BASE_URL": "http://your-yapi-server.com", "YAPI_TOKEN": "_yapi_token=YOUR_TOKEN_HERE; _yapi_uid=YOUR_UID_HERE", "NODE_ENV": "cli" } } } } Global Configuration: Add the same JSON block to your Cursor settings.json located at: * macOS: ~/Library/Application Support/Cursor/User/settings.json * Windows: %APPDATA%\Cursor\User\settings.json * Linux: ~/.config/Cursor/User/settings.json ---fetch call and asks the AI: "Look up the `api/v1/login` interface in the 'Auth' project and tell me what fields are required in the POST body." The AI retrieves the info and provides the exact JSON structure.
IOrderDetail based on its response structure."updateUser function with the YApi definition for the same endpoint. Are there any missing parameters or type mismatches?"Part of MCP Servers
You do not need a permanent local installation. YAPI MCP PRO is executed directly using npx. Ensure Node.js 16 or newer is available, then configure your MCP client configuration file with the command npx, arguments -y and yapi-mcp-pro, and your YApi environment variables.
It provides tools that let your AI assistant interact with your YApi workspace. The assistant can fetch your user profile details, list accessible projects, search for specific API endpoints across services, and inspect endpoint schemas and documentation directly inside your coding workflow.
It works with MCP-compatible clients that support stdio command execution, including Cursor and Claude Desktop. Setup requires adding the server definition to either project-level configuration files or global client settings.
Authentication uses your browser session cookies. Log in to your YApi instance in a web browser, inspect any network request using developer tools, and copy the full Cookie header string containing your _yapi_token and _yapi_uid into the YAPI_TOKEN environment variable.
Yes, YAPI MCP PRO is open source software distributed under the MIT license. You can inspect its source code and contribute to development on GitHub.