Yapi

MCP开发工具

提供方 未标注

开发工具 未标注 未标注 社区 / 第三方 ClaudeCursorVS CodeCodex

一个用于Yapi API管理平台的MCP服务器。

一句话选型结论

按资料字段整理

Yapi 属于开发工具类 MCP 服务器,传输方式未标注,鉴权方式未标注,可直接接入 Claude、Cursor、VS Code 等,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式未标注 鉴权未标注 部署方式未标注
GitHub 星标 未标注 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

开发

安装与配置

未标注 未标注
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 已适配 Claude、Cursor、VS Code,换客户端不用重新研究配置。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude、Cursor 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Yapi当前 未标注 未标注 未标注 无 未标注
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方未标注上游标注的维护方 未标注
分类开发工具本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式未标注远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验未标注上游最后核验时间

详细介绍

3.9 KB
来自项目仓库与上游目录的原文,未做删改

Yapi MCP Server

> Recommended: If you only need to search Yapi interfaces or get interface details, use the lightweight Yapi Skill first. It calls Yapi through local Python scripts and does not require starting the Java/Docker MCP server. Use this project when you need a full MCP server integration.

A Model Context Protocol (MCP) Server for Yapi API management platform. This project provides seamless integration between AI assistants and Yapi, allowing you to query API documentation, search interfaces, and manage API information through natural language.

For the Chinese version of this document, please see README_zh.md.

Features

This MCP server provides the following tools for interacting with Yapi:

Tool Description
listProjects List all configured Yapi projects with their IDs and names
listCategories Get interface categories for a specific Yapi project
listCatInterfaces List interfaces within a specific category
searchInterfaces Search API interfaces by project name, keyword, or path
getInterfaceDetail Get detailed information about a specific API interface
refreshCache Manually refresh the Yapi cache
clearProjectCache Clear cache for a specific project
getCacheStats Get cache statistics information

Prerequisites

Choose one of the following environments:

  • Java Environment: JDK 21+ and Maven 3.6+
  • Docker Environment: Docker and Docker Compose

Quick Start

Method 1: Run with Java```bash

Clone the repository

git clone https://github.com/yyykf/yapi-mcp-server.git
cd yapi-mcp-server

Configure Yapi URL and project tokens

vim src/main/resources/application-mcp.yml

Build the project

mvn clean package

Run the application

java -jar target/yapi-mcp-server-0.0.1-SNAPSHOT.jar


### Method 2: Run with Docker```bash
# Clone the repository
git clone https://github.com/yyykf/yapi-mcp-server.git
cd yapi-mcp-server

# Configure Yapi URL and project tokens
vim src/main/resources/application-mcp.yml

# Run with Docker Compose
docker-compose up -d

Configuration

Before running the application, you need to configure your Yapi connection settings in src/main/resources/application-mcp.yml:```yaml
spring:
cloud:
openfeign:
client:
config:
yapiClient:
url: http://yapi.com # Replace with your Yapi URL
yapi:
project-tokens:
123456: "your-project-token-1" # Project ID: Token
789012: "your-project-token-2" # Add more projects as needed


## Building Multi-Architecture Docker Images

If you need to build and push multi-architecture Docker images manually, use the provided script:```bash
./build-and-push.sh <version> <docker-username> <docker-password>

Example:```bash
./build-and-push.sh 1.0.0 myusername mypassword


This script will build images for both `amd64` and `arm64` architectures and create a multi-architecture manifest.

## Documentation

For more detailed project documentation and insights, you can explore the project using DeepWiki:

## Integration with Cursor

### Method 1: One-Click Install

Click the button below to automatically install the MCP server in Cursor:

### Method 2: Manual Configuration

Add the following configuration to your Cursor MCP settings file (`mcp.json`):```json
{
  "mcpServers": {
    "yapi": {
      "url": "http://127.0.0.1:8888/sse"
    }
  }
}

Health Check

Once the application is running, you can check its health status:bash curl http://localhost:8888/actuator/health

Or visit http://localhost:8888/actuator/health in your browser.

Usage Examples

After setting up the MCP server in Cursor, you can use natural language to interact with your Yapi instance:

  • "Show me all available projects"
  • "List all API categories in project 123456"
  • "Search for login APIs"
  • "Get details of interface ID 789"
  • "What's the cache status?"

License

This project is licensed under the MIT License - see the LICENSE file for details.

常见问题

6 问
答案由本站依据条目字段整理,不引用上游原文
Yapi 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

Yapi 怎么在 Claude、Cursor、VS Code 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Yapi 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Yapi 需要 API Key 吗?

资料没有标注鉴权方式,是否需要密钥取决于服务本身,接入前按官方文档确认。

Yapi 支持哪些客户端?

资料标注支持 Claude、Cursor、VS Code、Codex、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Yapi 能提供哪些能力?

资料显示能力标签包括 开发。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 未标注。