Yapi MCP Server

基本能力

产品定位

Yapi-MCP是一个基于YApi平台的MCP服务器，主要用于获取YApi平台的接口信息。

核心功能

• 获取指定的YApi接口描述信息

适用场景

• 开发者在开发过程中需要快速获取YApi接口信息
• 自动化工具需要集成YApi接口信息

工具列表

• get_api_desc: 获取指定的YApi接口描述信息
• 参数: apiId (string): YApi的接口ID

常见问题解答

• 无

使用教程

使用依赖

• 需要安装Node.js和pnpm

安装教程

1. 克隆项目
2. 在项目根目录运行以下命令安装依赖:

pnpm install

1. 在项目根目录创建 .env 文件，并配置以下环境变量:

# YApi配置
YAPI_TOKEN=your_yapi_token_here    # YApi平台的访问令牌
YAPI_BASE_URL=your_yapi_base_url_here    # YApi平台的基础URL地址

# 服务器配置
PORT=3334    # MCP服务器监听端口

1. 运行以下命令启动服务器:

pnpm run dev

调试方式

• 服务器启动后，可以通过访问指定的端口来测试API功能。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。