Yapi MCP Server 42458132

MCP开发工具

提供方 AlwaysLoveme · 包名 @zhuxian/yapi-mcp-server

开发工具 stdio · 本地进程 Token 社区 / 第三方 ClaudeCursor
查看接入方式

一个用于读取YAPI API文档的模型上下文协议服务器,支持LLM客户端浏览和检查YAPI项目接口。

一句话选型结论

按资料字段整理

Yapi MCP Server 42458132 属于开发工具类 MCP 服务器,stdio · 本地进程,Token,可直接接入 Claude、Cursor,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

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

工具与能力

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

能力标签

支持客户端

适用场景

API文档TypeScript本地部署接口管理LLM集成开发工具

安装与配置

stdio · 本地进程 Token
客户端在本机拉起子进程,数据不出本机
npx @zhuxian/yapi-mcp-server

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js,再按安装命令拉取依赖。

  2. 2
    安装服务

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

  3. 3
    写入客户端配置

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

  4. 4
    验证是否可用

    连接成功后客户端会列出约 7 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

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

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

本地命令与脚本

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

接口联调与测试

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

选择建议

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

值得选的地方

  • 资料标注 7 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

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

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Yapi MCP Server 42458132当前 7 stdio · 本地进程 本地部署 有 2026-05-17
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

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方AlwaysLoveme上游标注的维护方 AlwaysLoveme
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时@zhuxian/yapi-mcp-server · Node.js本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

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

YAPI MCP Server

中文文档

A Model Context Protocol (MCP) server for reading YAPI API documentation. Enables LLM clients (Claude Code, Cursor, etc.) to browse and inspect YAPI project interfaces.

Features

  • Browse project info, categories, and interfaces
  • Get full API detail including request/response schemas
  • Paginated listing with LLM-friendly Markdown output
  • Token-based authentication via environment variables

Requirements

  • Node.js >= 18.0.0

Installation

From npm```bash

npx @zhuxian/yapi-mcp-server


### From source```bash
git clone <repo-url>
cd yapi-mcp
npm install
npm run build

Configuration

The server requires three environment variables:

Variable Description Example
YAPI_BASE_URL Your YAPI instance URL https://yapi.example.com
YAPI_TOKEN Cookie token for authentication eyJhbGciOiJIUzI1NiIs...
YAPI_UID Your YAPI user ID 1828

> How to get Token and UID: Open browser DevTools -> Application -> Cookies, find _yapi_token and _yapi_uid values.

Usage

Claude Code

Option 1: Using CLI command```bash

Add to current project

claude mcp add yapi -e YAPI_BASE_URL=https://yapi.example.com -e YAPI_TOKEN=your_token -e YAPI_UID=1828 -- npx -y @zhuxian/yapi-mcp-server

Add globally (available in all projects)

claude mcp add yapi -s user -e YAPI_BASE_URL=https://yapi.example.com -e YAPI_TOKEN=your_token -e YAPI_UID=1828 -- npx -y @zhuxian/yapi-mcp-server


**Option 2: Manual configuration**

Add to `~/.claude/settings.json`:```json
{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": ["-y", "@zhuxian/yapi-mcp-server"],
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "your_token",
        "YAPI_UID": "1828"
      }
    }
  }
}

Cursor

Add to .cursor/mcp.json in your project root:```json
{
"mcpServers": {
"yapi": {
"command": "npx",
"args": ["-y", "@zhuxian/yapi-mcp-server"],
"env": {
"YAPI_BASE_URL": "https://yapi.example.com",
"YAPI_TOKEN": "your_token",
"YAPI_UID": "1828"
}
}
}
}


### Local Development```bash
YAPI_BASE_URL=https://yapi.example.com YAPI_TOKEN=xxx YAPI_UID=1828 npm run dev

Tools

yapi_get_project

Get project basic information including name, description, base path, and environment configurations.

Parameters:

Name Type Required Description
project_id number Yes The YAPI project ID

yapi_get_cat_menu

Get the list of interface categories (folders) for a project.

Parameters:

Name Type Required Description
project_id number Yes The YAPI project ID

yapi_list_interfaces

List interfaces in a project with pagination.

Parameters:

Name Type Required Description
project_id number Yes The YAPI project ID
page number No Page number (default: 1)
limit number No Items per page, max 100 (default: 20)

yapi_list_by_category

List interfaces belonging to a specific category with pagination.

Parameters:

Name Type Required Description
cat_id number Yes Category ID (from yapi_get_cat_menu)
page number No Page number (default: 1)
limit number No Items per page, max 100 (default: 20)

yapi_get_interface

Get complete details of a single API interface including request parameters, headers, body schema, and response schema.

Parameters:

Name Type Required Description
interface_id number Yes The interface ID

yapi_get_full_menu

Get all interfaces grouped by category. Returns the complete hierarchy for the project.

> Note: May return large payloads for projects with many interfaces.

Parameters:

Name Type Required Description
project_id number Yes The YAPI project ID

yapi_get_by_url

Parse a YAPI page URL and fetch the corresponding data automatically.

Parameters:

Name Type Required Description
url string Yes Full YAPI page URL

Supported URL formats:

  • /project/{id}/interface/api - Project overview
  • /project/{id}/interface/api/{interfaceId} - Interface detail
  • /project/{id}/interface/api/cat_{catId} - Category listing

Typical Workflow

A recommended sequence when exploring a YAPI project:1. yapi_get_project → Understand the project 2. yapi_get_cat_menu → See category structure 3. yapi_list_by_category → Browse interfaces in a category 4. yapi_get_interface → Get full detail for a specific API

Or simply use yapi_get_by_url with a YAPI page URL.

Scripts

Script Description
npm run build Compile with SWC + generate type declarations
npm run watch Watch mode compilation
npm run start Run the compiled server
npm run dev Run directly with tsx (no build needed)
npm run typecheck Type check without emitting

License

MIT

常见问题

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

在客户端按下面的安装命令接入:npx @zhuxian/yapi-mcp-server。对应的包名是 @zhuxian/yapi-mcp-server。装完在客户端配置里引用同一个包或端点。

Yapi MCP Server 42458132 怎么在 Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Yapi MCP Server 42458132 收费吗?

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

Yapi MCP Server 42458132 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

Yapi MCP Server 42458132 支持哪些客户端?

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

Yapi MCP Server 42458132 能提供哪些能力?

资料显示约 7 个工具;能力标签包括 API文档、TypeScript、Claude、开发工具。具体工具清单以官方文档为准。

Yapi MCP Server 42458132 需要什么运行环境?

运行时为 Node.js;属于本地进程,需要在本机装好运行环境。

Yapi MCP Server 42458132 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

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

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