接口获取-YAPI-MCP

Name: 接口获取-YAPI-MCP
Author: Gorvey

作者：Gorvey9 星标更新：2025-06-25

安装使用来源：spider==github.com

项目介绍

yapi-get-interface-mcp

一个用于获取YAPI接口详情的MCP（模型上下文协议）服务器，支持与AI开发工具如cursor和Claude Desktop集成。

使用说明

可用工具

yapi-get-interface

根据接口ID获取YAPI接口详情

参数

id 接口ID（数字格式）

使用示例：

AI工具会自动调用该工具并返回完整的接口信息，包括：

基本接口信息（名称、路径、方法等）
请求参数（路径参数、查询参数、请求头、请求体）
响应信息（响应体、响应类型等）
其他元数据（创建时间、状态、标签等）

参数

参数	描述	必填	示例
`--email`	YAPI登录邮箱	是	`--email admin@company.com`
`--password`	YAPI登录密码	是	`--password mypassword`
`--url`	YAPI服务器地址	是	`--url https://yapi.company.com`

快速开始

在cursor中配置

创建或编辑.cursor/mcp.json文件（项目级别配置）或~/.cursor/mcp.json文件（全局配置）：

{
    "mcpServers": {
        "yapi-get-interface-mcp": {
            "command": "npx",
            "args": [
                "yapi-get-interface-mcp",
                "--email", "your@email.com",
                "--password", "yourpassword",
                "--url", "https://yapi.yourcompany.com"
            ]
        }
    }
}

环境要求

Node.js >= 18.0.0
pnpm >= 8.0.0

安装

可以直接运行NPX，无需本地安装：

# 克隆项目
git clone https://github.com/Gorvey/yapi-get-interface-mcp.git
cd yapi-get-interface-mcp

# 安装依赖
pnpm install

# 构建项目
pnpm run build

开发指南

项目结构

src/
├── config/           # 配置管理
│   └── yapi-config.ts
├── server/           # MCP服务器
│   ├── server.ts
│   ├── tools.ts
│   └── resources.ts
├── yapi/             # YAPI客户端
│   └── client.ts
└── index.ts          # 入口文件

开发脚本

# 开发模式（带示例配置）
pnpm run dev

# 监听文件变化自动构建
pnpm run watch

# 清理构建文件
pnpm run clean

# 构建项目
pnpm run build

# 使用MCP Inspector调试
pnpm run inspector

调试

使用MCP Inspector进行调试：

pnpm run inspector

这将启动一个交互界面，帮助您测试和调试MCP工具。

常见问题

1. YAPI连接失败

检查YAPI服务器地址是否正确
确认邮箱和密码是否正确
检查网络连接及YAPI服务器可达性

2. 无效的接口ID

确保接口ID是数字格式
检查接口是否存在于YAPI中
确认是否有访问接口的权限

3. MCP服务器未被识别

确保项目已正确构建（pnpm run build）
检查配置文件中的路径是否正确
重启AI开发工具

许可证

MIT许可证

贡献

欢迎提交Issue和Pull Requests以改进此项目。