a month ago
这是一个 Model Context Protocol (MCP) 服务器，用于与 YApi 接口管理平台集成，支持自动生成 TypeScript 类型定义、Mock 数据和 API 请求代码。
Overview
What is Yapi Mcp?
Yapi Mcp is a Model Context Protocol (MCP) server designed for integration with the YApi interface management platform, enabling automatic generation of TypeScript type definitions, mock data, and API request code.
How to use Yapi Mcp?
To use Yapi Mcp, install the server using the command npx -y @vtian/yapi-mcp-server --stdio, configure your yapi.config.json file with the necessary parameters, and utilize the provided MCP tools to interact with YApi data.
Key features of Yapi Mcp?
- Automatic reading of project configuration files.
- Fetching complete interface information from YApi with caching support.
- Generation of TypeScript interface definitions based on response schemas.
- Intelligent generation of mock test data.
- Automatic generation of Axios or Fetch style API request functions.
- Smart caching mechanism to reduce network requests.
Use cases of Yapi Mcp?
- Automatically generating TypeScript types for API responses.
- Creating mock data for testing purposes.
- Simplifying API request code generation for frontend applications.
FAQ from Yapi Mcp?
- Can Yapi Mcp work with any YApi project?
Yes! Yapi Mcp is designed to integrate seamlessly with any YApi project that provides the necessary configuration.
- Is Yapi Mcp free to use?
Yes! Yapi Mcp is open-source and free for everyone to use.
- How does the caching mechanism work?
Yapi Mcp caches YApi data for 30 minutes to minimize network requests and improve performance.
Server Config
{
"mcpServers": {
"yapi-mcp": {
"command": "npx",
"args": [
"-y",
"@vtian/yapi-mcp-server",
"--stdio"
]
}
}
}