YAPI MCP 工具

这是一个用于获取 YAPI 接口信息的 MCP（Model Context Protocol）工具。

功能特点

• 通过 URL 获取 YAPI 接口详细信息
• 支持工具名称自定义前缀
• 支持命令行参数配置

安装

# 安装依赖
npm install @modelcontextprotocol/sdk axios zod

配置

工具运行需要以下配置：

1. YAPI Token：从 YAPI 平台获取的访问令牌
2. YAPI URL：YAPI 服务器地址

使用方法

基本使用

node yapi-mcp.ts --token=your_token --url=https://yapi.example.com

参数说明

• --token: （必需）YAPI 访问令牌
• --url: （必需）YAPI 服务器地址
• --prefix: （可选）工具名称前缀

示例

1. 基本使用（工具名称为 getApiSpec）：

node yapi-mcp.ts --token=your_token --url=https://yapi.example.com

2. 使用自定义前缀（工具名称为 customPrefixGetApiSpec）：

node yapi-mcp.ts --token=your_token --url=https://yapi.example.com --prefix=customPrefix

工具使用

在支持 MCP 的环境中，可以通过以下方式调用工具：

// 基本调用
getApiSpec({
    url: "https://yapi.example.com/project/22/interface/api/14799"
})

// 带前缀调用（如果配置了前缀）
customPrefixGetApiSpec({
    url: "https://yapi.example.com/project/22/interface/api/14799"
})

返回数据

工具会返回接口的详细信息，包括：

• 接口标题
• 请求路径
• 请求方法
• 请求参数
• 响应数据结构
• 接口描述 等

注意事项

1. 确保提供的 YAPI Token 具有足够的访问权限
2. URL 必须是完整的 YAPI 接口地址
3. 如果使用前缀功能，建议使用有意义的前缀名称

错误处理

工具会在以下情况返回错误：

• 无效的 YAPI URL
• Token 无效或过期
• 接口不存在
• 网络连接问题

开发说明

如需修改或扩展工具功能，主要文件说明：

• yapi-mcp.ts: 主程序文件
• .npmrc: npm 配置文件，用于设置 registry 和认证信息