AgentStack
Browse Sign in
Browse Why AgentStack Sell Docs
Sign in
MCP verified MIT Self-run

Yapi Mcp Pro

mcp-guocong-bincai-yapi-mcp-pro · by guocong-bincai

一个功能强大的 Model Context Protocol (MCP) 服务器,专为 YApi 接口管理平台设计。支持在 Cursor、Claude Desktop 等 AI 编辑器中直接操作 YApi,提供完整的接口生命周期管理功能。

No reviews yet
0 installs
32 views
0.0% view→install

Install

$ agentstack add mcp-guocong-bincai-yapi-mcp-pro

✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.

Security review

✓ Passed

No issues found. Passed automated security review. · v0.1.0 How review works →

  • Prompt-injection patterns
  • Secret / credential exfiltration
  • Dangerous shell & filesystem operations
  • Untrusted network calls
  • Known-malicious package signatures

What it can access

  • Network access Used
  • Filesystem access No
  • Shell / process execution No
  • Environment & secrets Used
  • Dynamic code execution No

From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.

View the full security report →

Verified badge

Passed review? Show it. Paste this badge into your README, it links to the public security report.

AgentStack Verified badge Links to your public security report.
[![AgentStack Verified](https://agentstack.voostack.com/badges/verified.svg)](https://agentstack.voostack.com/security/report/mcp-guocong-bincai-yapi-mcp-pro)

Reliability & compatibility

Security review passed
0 installs to date
no reviews yet
stale · 1y ago

Declared compatibility

Claude CodeClaude DesktopCursorWindsurf

Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.

Preview Execution monitoring

We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.

How agent discovery & health will work →
Are you the author of Yapi Mcp Pro? Claim this listing to set pricing, connect Stripe payouts, and keep 70% of every sale.
Sign up to claim

About

🚀 YAPI MCP PRO - 专业级YApi接口管理工具

[](https://opensource.org/licenses/MIT) [](https://nodejs.org/) [](https://www.typescriptlang.org/)

一个功能强大的 Model Context Protocol (MCP) 服务器,专为 YApi 接口管理平台设计。支持在 Cursor、Claude Desktop 等 AI 编辑器中直接操作 YApi,提供完整的接口生命周期管理功能。

🚨 常见问题快速解决

⚠️ 重要:NPM缓存问题(必看!)

如果您遇到连接问题,首先检查这个:

# 1. 检查版本命令是否正常
npx yapi-mcp-pro --version

# 2. 如果上面命令没有正常输出版本号,执行清缓存:
npm cache clean --force

# 3. 然后重新测试
npx yapi-mcp-pro --version

🔍 判断标准

  • 正常:显示版本号如 0.2.1
  • 异常:显示错误信息、找不到命令、或者卡住不动

> 💡 为什么会出现这个问题? > NPM缓存可能损坏或过期,导致无法正确下载或运行包。清理缓存可以解决大部分连接问题。

🔧 快速故障排查清单

| 检查项 | 正常状态 | 异常处理 | |--------|----------|----------| | 🔥 NPM包版本 | npx yapi-mcp-pro --version 有输出 | 必须执行: npm cache clean --force | | YApi服务可访问 | curl -I {YAPI_URL} 返回200 | 检查YApi服务状态、网络连接 | | Token有效性 | 能正常访问YApi接口 | 重新获取Token或检查权限 | | 环境变量 | YAPI_BASE_URLYAPI_TOKEN已设置 | 检查环境变量或配置文件 |

🚦 Cursor状态灯说明

| 状态 | 含义 | 解决方案 | |------|------|----------| | 🟢 绿灯 | 连接正常 | 可以正常使用 | | 🔴 红灯 | 连接失败 | 1. 先执行 npm cache clean --force2. 检查配置文件3. 验证YApi连接 | | 🟡 黄灯 | 连接超时 | 检查网络、防火墙设置 | | ⚫ 无显示 | 配置错误 | 检查JSON语法、重新配置 |

💊 一键修复脚本

如果遇到问题,复制以下命令一键修复:

# 清理NPM缓存并重新安装
npm cache clean --force && npx clear-npx-cache 2>/dev/null || true

# 验证安装
npx yapi-mcp-pro --version

# 测试YApi连接(替换为您的实际地址)
curl -I "http://your-yapi-server.com"

🚀 想要立即开始?

只需要2样东西:

  1. 📍 您的YApi服务器地址
  2. 🍪 浏览器中的Cookie

⏱️ 配置时间:不到5分钟

[👉 点击这里开始配置](#-5分钟快速开始)

⚡ 5分钟快速开始

> 🎯 推荐方式:使用NPM包的stdio模式,无需本地构建,开箱即用! > > 📦 自动更新:使用 npx -y yapi-mcp-pro 确保总是使用最新版本 > > 🔒 安全便捷:Cookie认证自动发现所有项目,配置简单

🚀 完全新手?3步搞定!

如果您是第一次接触,按这个顺序:

  1. 📥 安装Node.js → [点击查看详细安装指南](#-nodejs-完整安装指南新手必看)
  2. 🔧 配置Cursor → [继续下面的配置步骤](#🔧-第二步配置cursor)
  3. 🎉 开始使用 → [测试连接和使用](#🚀-第三步开始使用)

> 💡 已经有Node.js? 直接从第2步开始!

🎯 第一步:获取YApi认证信息

1. 获取YApi服务器地址

从浏览器地址栏复制您的YApi服务器地址,例如:http://your-yapi-server.com

2. 获取Cookie认证信息(推荐方式)
  1. 登录YApi: 在浏览器中正常登录您的YApi系统
  2. 打开开发者工具: 按 F12 或右键选择"检查"
  3. 切换到Network面板: 点击"Network"(网络)标签
  4. 触发网络请求: 在YApi页面中随便点击一个功能(如刷新页面)
  5. 查看请求详情: 点击任意一个网络请求(如下图红框所示)
  6. 找到Cookie字段: 在右侧面板中找到"Request Headers"
  7. 复制Cookie值: 找到"Cookie"字段,复制完整的Cookie值(如下图红框所示)

> 💡 重要提示: > - Cookie必须包含 _yapi_token_yapi_uid 两个关键字段 > - 完整格式如:_yapi_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...; _yapi_uid=1413; 其他cookie值 > - 请复制完整的Cookie字符串,不要遗漏任何部分

🔍 Cookie内容示例

_yapi_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...(您的完整token); _yapi_uid=您的用户ID; keep-alive

🔧 第二步:配置Cursor

方式一:项目级配置(推荐)

步骤

  1. 在您的项目根目录创建 .cursor 文件夹(如果不存在)
  2. .cursor 文件夹中创建 mcp.json 文件
  3. 复制以下配置内容到文件中:

💻 终端快速创建

# 创建目录和文件
mkdir -p .cursor
touch .cursor/mcp.json

# 然后编辑文件内容
{
  "mcpServers": {
    "yapi-mcp-pro": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-pro"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "_yapi_token=您的真实token; _yapi_uid=您的用户ID",
        "NODE_ENV": "cli"
      }
    }
  }
}

📝 配置示例(请替换为您的真实信息):

{
  "mcpServers": {
    "yapi-mcp-pro": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-pro"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "_yapi_token=您的真实token值; _yapi_uid=您的用户ID",
        "NODE_ENV": "cli"
      }
    }
  }
}
方式二:全局配置

编辑Cursor全局配置文件:

  • macOS: ~/Library/Application Support/Cursor/User/settings.json
  • Windows: %APPDATA%\Cursor\User\settings.json
  • Linux: ~/.config/Cursor/User/settings.json

添加相同的配置内容。

🚀 第三步:开始使用

  1. 重启Cursor - 让MCP配置生效
  2. 测试连接 - 在Cursor中输入以下命令测试:
请获取我的YApi用户信息
请列出所有YApi项目
请搜索用户相关的接口
  1. 开始管理API - 现在您可以通过AI助手管理YApi接口了!

🆘 快速问题解决

❓ 提示"与YApi服务器通信失败"?
  • 检查 YAPI_BASE_URL 是否正确
  • 确保网络能访问YApi服务器
  • 验证YApi服务器是否正常运行
❓ 提示"请登录"或"认证失败"?
  • 重新获取Cookie,确保包含 _yapi_token_yapi_uid
  • 检查Cookie是否完整,没有被截断
  • 确认YApi登录状态是否有效
❓ Cursor中看不到MCP工具?
  • 确认已重启Cursor
  • 检查配置文件路径和格式是否正确
  • 查看Cursor的MCP连接状态
❓ 需要更多帮助?
  • 查看 [详细配置指南](#-详细配置指南)
  • 查看 [故障排除](#-故障排除) 章节
  • 提交 GitHub Issue

🔧 环境要求与兼容性检查

📋 最低系统要求

在开始配置之前,请确保您的系统满足以下要求:

| 要求项 | 最低版本 | 推荐版本 | 验证命令 | |--------|----------|----------|----------| | Node.js | 16.0.0+ | 18.0.0+ | node --version | | npm | 7.0.0+ | 9.0.0+ | npm --version | | 网络访问 | - | - | 能访问YApi服务器和NPM Registry |

🚀 Node.js 完整安装指南(新手必看)

> 💡 如果您已经安装了Node.js,可以跳过此部分 > > 检查是否已安装:在终端/命令提示符中输入 node --version > - 如果显示版本号(如 v18.17.0),说明已安装 > - 如果提示 "command not found" 或类似错误,需要安装

🎯 方式一:官方安装器(推荐新手)

第一步:访问官网下载

  1. 打开浏览器,访问 https://nodejs.org/
  2. 页面会自动识别您的操作系统
  3. 点击绿色的 "Download Node.js (LTS)" 按钮

第二步:根据您的操作系统选择

| 操作系统 | 下载文件 | 安装方式 | |----------|----------|----------| | Windows | node-v18.x.x-x64.msi | 双击运行,按向导安装 | | macOS | node-v18.x.x.pkg | 双击运行,按向导安装 | | Linux | node-v18.x.x-linux-x64.tar.xz | 解压或使用包管理器 |

第三步:安装过程

🪟 Windows 用户:

  1. 双击下载的 .msi 文件
  2. 点击 "Next" 接受许可协议
  3. 选择安装路径(建议使用默认路径)
  4. 重要:确保勾选 "Add to PATH" 选项
  5. 点击 "Install" 开始安装
  6. 安装完成后重启命令提示符

🍎 macOS 用户:

  1. 双击下载的 .pkg 文件
  2. 按照安装向导提示操作
  3. 输入管理员密码(如果需要)
  4. 安装完成后重启终端

🐧 Linux 用户:

# 下载并解压(以Ubuntu为例)
wget https://nodejs.org/dist/v18.17.0/node-v18.17.0-linux-x64.tar.xz
tar -xf node-v18.17.0-linux-x64.tar.xz

# 移动到系统目录
sudo mv node-v18.17.0-linux-x64 /opt/nodejs

# 创建软链接
sudo ln -s /opt/nodejs/bin/node /usr/local/bin/node
sudo ln -s /opt/nodejs/bin/npm /usr/local/bin/npm
sudo ln -s /opt/nodejs/bin/npx /usr/local/bin/npx
⚡ 方式二:包管理器安装(适合有经验用户)

🪟 Windows (使用 Chocolatey):

# 首先安装Chocolatey (如果没有)
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

# 安装Node.js
choco install nodejs

# 验证安装
node --version
npm --version

🍎 macOS (使用 Homebrew):

# 首先安装Homebrew (如果没有)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# 安装Node.js
brew install node

# 验证安装
node --version
npm --version

🐧 Linux (使用包管理器):

# Ubuntu/Debian
sudo apt update
sudo apt install nodejs npm

# CentOS/RHEL (使用dnf)
sudo dnf install nodejs npm

# CentOS/RHEL (使用yum)
sudo yum install nodejs npm

# Arch Linux
sudo pacman -S nodejs npm

# 验证安装
node --version
npm --version
🔍 安装验证

安装完成后,请执行以下命令验证:

# 检查Node.js版本(应显示 v16.0.0 或更高版本)
node --version

# 检查npm版本(应显示 7.0.0 或更高版本)
npm --version

# 检查npx是否可用
npx --version

# 测试npm连接(可选)
npm ping

✅ 成功安装的标志:

  • node --version 显示版本号(如:v18.17.0
  • npm --version 显示版本号(如:9.6.7
  • npx --version 显示版本号(如:9.6.7
⚠️ 常见安装问题

❌ "node: command not found"

  • Windows: 重启命令提示符,或检查环境变量PATH
  • macOS/Linux: 重启终端,或手动添加到PATH:

``bash echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc source ~/.bashrc ``

❌ 版本过低

# 更新到最新版本
npm install -g npm@latest

# 或重新下载安装最新版Node.js

❌ 权限问题

# macOS/Linux: 修复npm权限
sudo chown -R $(whoami) ~/.npm
sudo chown -R $(whoami) /usr/local/lib/node_modules

❌ 网络问题(中国用户)

# 切换到国内镜像源
npm config set registry https://registry.npmmirror.com

# 验证镜像源
npm config get registry
🎉 安装成功后的建议配置
# 设置npm全局安装目录(避免权限问题)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'

# 添加到环境变量(macOS/Linux)
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.profile
source ~/.profile

# Windows用户需要手动添加 %USERPROFILE%\.npm-global 到PATH环境变量
🚀 验证YApi MCP Pro可用性

安装Node.js后,立即测试我们的工具:

# 测试YApi MCP Pro是否可以正常运行
npx -y yapi-mcp-pro --help

# 如果看到帮助信息,说明环境配置成功!

看到类似输出表示成功:

选项:
  --version            显示版本号
  --yapi-base-url      YApi服务器基础URL
  --yapi-token         YApi服务器授权Token
  --help               显示帮助信息

🔍 环境检查脚本

一键检查所有环境要求

# Windows (PowerShell)
echo "=== YApi MCP Pro 环境检查 ===" && echo "Node.js版本:" && node --version && echo "NPM版本:" && npm --version && echo "网络连通性:" && npm ping

# macOS/Linux
echo "=== YApi MCP Pro 环境检查 ===" && echo "Node.js版本:" && node --version && echo "NPM版本:" && npm --version && echo "测试NPM连接:" && npm ping

# 检查NPX可用性
npx --version

⚠️ 常见环境问题

❌ "node: command not found"

问题: 系统未安装Node.js 解决方案:

  • 访问 nodejs.org 下载安装最新LTS版本
  • 或使用包管理器:

```bash # macOS (使用Homebrew) brew install node

# Ubuntu/Debian sudo apt update && sudo apt install nodejs npm

# Windows (使用Chocolatey) choco install nodejs ```

❌ "npx: command not found"

问题: NPX未正确安装 解决方案:

# 重新安装NPM (NPX包含在NPM中)
npm install -g npm@latest

# 或单独安装NPX
npm install -g npx
❌ "EACCES: permission denied"

问题: 权限不足 解决方案:

# macOS/Linux: 修复NPM权限
sudo chown -R $(whoami) ~/.npm
sudo chown -R $(whoami) /usr/local/lib/node_modules

# 或配置NPM使用不同目录
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH
❌ 网络连接问题

问题: 无法下载NPM包 解决方案:

# 检查NPM Registry连接
npm config get registry

# 切换到国内镜像(如果在中国)
npm config set registry https://registry.npmmirror.com

# 测试网络连接
curl -I https://registry.npmjs.org

🌍 不同平台的详细配置

🍎 macOS 配置指南

第一步:安装依赖

# 安装Node.js (推荐使用Homebrew)
brew install node

# 验证安装
node --version && npm --version

第二步:配置Cursor

# 创建配置目录
mkdir -p ~/.config/Cursor/User

# 编辑配置文件
code ~/.config/Cursor/User/settings.json
# 或使用任意文本编辑器

第三步:添加MCP配置settings.json 中添加:

{
  "mcpServers": {
    "yapi-mcp-pro": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-pro"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "您的完整Cookie字符串",
        "NODE_ENV": "cli"
      }
    }
  }
}
🪟 Windows 配置指南

第一步:安装依赖

# 使用官方安装器
# 访问 https://nodejs.org/ 下载Windows安装包

# 或使用Chocolatey
choco install nodejs

# 验证安装
node --version; npm --version

第二步:配置Cursor

# 打开配置目录
explorer %APPDATA%\Cursor\User\

# 编辑settings.json文件
# 如果文件不存在,创建它

第三步:添加MCP配置 创建或编辑 %APPDATA%\Cursor\User\settings.json

{
  "mcpServers": {
    "yapi-mcp-pro": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-pro"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "您的完整Cookie字符串",
        "NODE_ENV": "cli"
      }
    }
  }
}
🐧 Linux 配置指南

第一步:安装依赖

# Ubuntu/Debian
sudo apt update
sudo apt install nodejs npm

# CentOS/RHEL/Fedora
sudo dnf install nodejs npm  # Fedora
sudo yum install nodejs npm  # CentOS/RHEL

# Arch Linux
sudo pacman -S nodejs npm

# 验证安装
node --version && npm --version

第二步:配置Cursor

# 创建配置目录
mkdir -p ~/.config/Cursor/User

# 编辑配置文件
nano ~/.config/Cursor/User/settings.json
# 或使用您喜欢的编辑器

第三步:添加MCP配置

{
  "mcpServers": {
    "yapi-mcp-pro": {
      "command": "npx",
      "args": ["-y", "yapi-mcp-pro"],
      "env": {
        "YAPI_BASE_URL": "http://your-yapi-server.com",
        "YAPI_TOKEN": "您的完整Cookie字符串",
        "NODE_ENV": "cli"
      }
    }
  }
}

🧪 配置验证

完成配置后,使用以下步骤验证

  1. 测试MCP服务器可执行性
# 在任意目录运行
npx -y yapi-mcp-pro --help
  1. 检查Cursor配置
  • 重启Cursor
  • 打开任意项目
  • 在聊天中输入:"请获取我的YApi用户信息"
  1. 验证连接状态
  • 成功:返回用户信息
  • 失败:检查错误信息并参考 [故障排除](#-故障排除) 章节

📊 配置成功指标

成功配置的标志

  • npx -y yapi-mcp-pro --help 能正常显示帮助信息
  • Cursor重启后在MCP连接状态中显示 yapi-mcp-pro
  • AI助手能正常响应YApi相关请求
  • 能成功获取用户信息和项目列表

📋 目录

  • [⚡ 5分钟快速开始](#-5分钟快速开始) - 推荐先看这里
  • [✨ 核心特性](#-核心特性)
  • [🎯 支持的AI编辑器](#-支持的ai编辑器)
  • [🔧 详细配置指南](#-详细配置指南)
  • [📚 MCP工具详解](#-mcp工具详解)
  • [💡 使用示例](#-使用示例)
  • [🛠️ 项目管理](#️-项目管理)
  • [🔍 故障排除](#-故障排除)
  • [📖 高级用法](#-高级用法)
  • [🤝 贡献指南](#-贡献指南)

✨ 核心特性

🎯 全面的接口管理

  • 接口CRUD: 创建、读取、更新、删除接口
  • 智能搜索: 多维度搜索接口(名称、路径、项目)
  • 批量操作: 支持接口复制、批量导入导出
  • 实时同步: 与YApi服务器实时同步数据

🏗️ 项目与分类管理

  • 项目管理: 创建、更新项目信息
  • 分类管理: 完整的接口分类生命周期管理
  • 权限控制: 基于YApi权限系统的安全访问

👥 用户与团队协作

  • 用户信息: 获取当前用户详细信息
  • 团队管理: 查看用户所属分组和权限

🧪 测试与质量保证

  • 测试集合: 管理接口测试用例集合
  • 数据导入导出: 支持Swagger、JSON等格式

⚡ 性能与体验

  • 智能缓存: 多层缓存机制,提升响应速度
  • 实时通信: SSE支持,实时数据更新
  • 双重认证: Cookie和Token两种认证方式
  • 详细日志: 完整的操作日志和错误追踪

🎯 支持的AI编辑器

| 编辑器 | 支持状态 | 配置方式 | |--------|----------|----------| | Cursor | ✅ 完全支持 | MCP配置 | | Claude Desktop | ✅ 完全支持 | MCP配置 | | VS Code | 🔄 开发中 | 插件形式 | | 其他支持MCP的工具 | ✅ 理论支持 | 标准MCP协议 |

🔧 详细配置指南

1. 环境要求

  • Node.js: >= 16.0.0
  • npm/pnpm: 最新版本
  • YApi服务器: 可访问的YApi实例

2. 安装部署

方式一:npm安装(推荐)
# 全局安装
npm install -g yapi-mcp

# 或使用pnpm
pnpm add -g yapi-mcp
方式二:源码安装
# 克隆项目
git clone https://github.com/your-username/yapi-mcp.git
cd yapi-mcp

# 安装依赖
npm install
# 或使用 pnpm (推荐)
pnpm install

# 构建项目
npm run build

3. 快速配置

📁 配置文件说明

项目的所有敏感信息都集中在 .env 文件中,这个文件不会被提交到Git,确保您的隐私安全。

# 1. 复制配置模板
cp .env.example .env

# 2. 编辑配置文件(选择您喜欢的编辑器)
vim .env
# 或者
nano .env
# 或者
code .env

💡 提示: .env.example 文件包含了超详细的配置指南,包括:

  • 🍪 Cookie认证的分步骤获取方法(推荐)
  • 🔑 Token认证的完整操作流程
  • 📋 真实格式的配置示例
  • ✅ 配置验证和测试方法

强烈建议先阅读 .env.example 文件中的详细说明!

🔐 必填配置项

打开 .env 文件,您需要填写以下必填项

# === 必填项 ===
YAPI_BASE_URL=http://your-yapi-server.com    # 替换为您的YApi服务器地址
YAPI_TOKEN=your_auth_token                   # 替换为您的认证信息(见下方获取方法)

# === 可选项(有默认值)===
PORT=3388                                    # MCP服务端口,默认3388
YAPI_CACHE_TTL=10                           # 缓存时间(分钟),默认10分钟
YAPI_LOG_LEVEL=info                         # 日志级别,默认info
🎯 获取认证信息的两种方式
方式一:Cookie认证(推荐)⭐

优势: 自动发现所有有权限的项目,配置简单

步骤:

  1. 打开浏览器,登录您的YApi系统
  2. F12 打开开发者工具
  3. 切换到 Network(网络)面板
  4. 在YApi页面中随便点击一个功能(如刷新页面)
  5. 在网络请求中找到任意一个请求,点击查看详情
  6. 找到 Request Headers 中的 Cookie 字段
  7. 复制整个Cookie值
# Cookie认证示例(复制您自己的Cookie)
YAPI_TOKEN=_yapi_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...; _yapi_uid=1234; other_cookies=values
方式二:Token认证

优势: 长期有效,更安全

步骤:

  1. 登录YApi,进入您要管理的项目
  2. 点击项目 设置Token配置
  3. 复制项目Token和项目ID
  4. 按格式配置多个项目(如有需要)
# Token认证示例
# 格式:项目ID:项目Token,项目ID:项目Token
YAPI_TOKEN=PROJECT_ID_1:your_project_token_1,PROJECT_ID_2:your_project_token_2

# 单个项目示例
YAPI_TOKEN=PROJECT_ID:your_project_token
📋 完整配置示例
# ================================
# YAPI MCP PRO 配置文件
# ================================
# ⚠️ 重要:此文件包含敏感信息,不要提交到Git仓库!

# === 基础配置(必填)===
YAPI_BASE_URL=http://yapi.yourcompany.com
YAPI_TOKEN=_yapi_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...; _yapi_uid=1234

# === 服务配置(可选)===
PORT=3388
YAPI_CACHE_TTL=10
YAPI_LOG_LEVEL=info

# === 高级配置(可选)===
# YAPI_GROUP_ID=YOUR_GROUP_ID      # 默认分组ID(创建项目时使用)
# YAPI_ENABLE_CACHE=true          # 是否启用缓存,默认true

4. 启动服务

# 使用项目管理脚本(推荐)
./start-mcp.sh start

# 或手动启动
npm run dev

🔧 配置指南

认证方式选择

🍪 Cookie认证(推荐)

优势: 自动发现所有项目,配置简单,权限完整

获取步骤:

  1. 浏览器登录YApi
  2. 打开开发者工具 (F12)
  3. 网络面板中复制任意请求的Cookie
  4. 配置到 .env 文件
# Cookie认证配置
YAPI_BASE_URL=http://your-yapi-server.com
YAPI_TOKEN=_yapi_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...; _yapi_uid=YOUR_USER_ID
🔑 Token认证

优势: 长期有效,安全性高,适合生产环境

获取步骤:

  1. YApi项目 → 设置 → Token配置
  2. 复制项目Token和项目ID
  3. 按格式配置多个项目
# Token认证配置
YAPI_BASE_URL=http://your-yapi-server.com
YAPI_TOKEN=PROJECT_ID:YOUR_PROJECT_TOKEN,ANOTHER_PROJECT_ID:ANOTHER_TOKEN

完整配置参数

# === 基础配置 ===
YAPI_BASE_URL=http://your-yapi-server.com    # YApi服务器地址
PORT=3388                                     # MCP服务端口

# === 认证配置 ===
YAPI_TOKEN=your_auth_info                     # 认证信息(Cookie或Token)

# === 性能配置 ===
YAPI_CACHE_TTL=10                            # 缓存时间

…

## Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [guocong-bincai](https://github.com/guocong-bincai)
- **Source:** [guocong-bincai/Yapi_mcp_pro](https://github.com/guocong-bincai/Yapi_mcp_pro)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

Reviews

No reviews yet, be the first.

Versions

  • v0.1.0 Imported from the upstream source.