YApi MCP Server
Click on "Deploy 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 Serverget details for interface ID 789"
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
A MCP (Model Context Protocol) server for accessing YApi interface documentation.
Features
📝 Get interface details by ID
🔗 Support YApi URL auto-parsing
Related MCP server: YApi MCP Server
Claude Desktop Configuration
{
"mcpServers": {
"yapi": {
"command": "npx",
"args": ["-y", "yapi-mcp-server@latest"],
"env": {
"YAPI_BASE_URL": "http://your-yapi-server.com",
"YAPI_TOKEN": "your-yapi-token"
}
}
}
}Environment Variables
YAPI_BASE_URL: Your YApi server URLYAPI_TOKEN: YApi access token
How to Get Token
Login to YApi → Profile Settings → Copy Token
Usage
Direct URL
Please get the information for this interface: http://localhost:40001/project/11/interface/api/23Tool Name
Please use yapi-get-interface tool to get details for interface ID 789License
MIT
Available Tools
2 toolsyapi-get-interfaceB
根据接口ID获取接口详情
Inputs: interfaceId (required).
yapi-get-interface-by-urlC
根据YApi URL获取接口详情,支持格式如:http://localhost:40001/project/11/interface/api/23
Inputs: url (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
TDQS
Scored across 2 tools
The two tools have clearly distinct purposes: one retrieves interface details by ID, while the other retrieves them by URL. There is no overlap or ambiguity between their functions, making it easy for an agent to select the correct tool based on the available input.
Both tools follow a consistent naming pattern: 'yapi-get-interface' with a suffix indicating the input type ('-by-url'). This verb_noun structure is uniform and predictable, enhancing readability and usability across the tool set.
With only 2 tools, the server feels under-scoped for a YApi (API management) domain. This minimal set lacks essential operations like creating, updating, or listing interfaces, which are typical for such systems, making it insufficient for comprehensive agent workflows.
The tool surface is severely incomplete for API management. It only provides retrieval methods (by ID and URL), missing critical CRUD operations such as create, update, delete, or list interfaces. This creates significant gaps that will likely cause agent failures in handling full lifecycle tasks.
Maintenance
Related MCP Connectors
Read-only HotAPI documentation: search integration guides and inspect OpenAPI operations.
Turn any task into the right API calls: discover, evaluate, and integrate public APIs.
Publish your API docs so AI assistants can look up endpoints and call your API correctly.
Search and read the Flowie Exchange API docs and OpenAPI contract. No sign-in needed.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables direct integration with YApi API documentation platform in MCP-compatible editors like Cursor, allowing users to query API details, list interfaces, and search endpoints by simply pasting YApi URLs.510 npmMIT
- AlicenseNot gradedqualityDmaintenanceEnables reading and searching API documentation from YApi instances, allowing AI models to access interface definitions, project API lists, and search through API endpoints using YApi URLs or project IDs.5 npmMIT
- AlicenseNot gradedqualityDmaintenanceEnables interaction with YApi API management platform through natural language, allowing automated interface management including creating/updating APIs, managing categories, importing data, and retrieving project information.26 npm9GPL 3.0
- AlicenseAqualityDmaintenanceEnables LLM clients to browse and inspect YAPI API documentation, including project info, categories, interfaces, and full API details with request/response schemas.710 npm1MIT