Ruft YApi JSON API-Dokumentationen von Projekt-URLs ab, damit KI-Agenten Client-Projekte besser verstehen und integrieren können.
Auch bekannt als ContextDong/Yapi-Mcp, yapi-mcp, contextdong-yapi-mcp
- Stars
- 0
- Tools
- —
- Downloads, 30 Tage
- —
- Neueste Version
- 0.1.0
- Letzter Commit
- 2. Nov. 2026
- Lizenz
- MIT
Was ist YApi MCP?
Ruft YApi JSON API-Dokumentationen von Projekt-URLs ab, damit KI-Agenten Client-Projekte besser verstehen und integrieren können.
Zusammenfassung generiert aus dem README des Projekts
Über YApi MCP server
YApi MCP bietet KI-Coding-Agenten eine Möglichkeit, auf API-Dokumentationen zuzugreifen, die in YApi gespeichert sind. Durch die Verbindung zu deiner YApi-Instanz ermöglicht der Server den Agenten, JSON-Request- und Response-Schemas abzurufen. Das hilft ihnen dabei, Client-seitigen Code zu schreiben, der exakt deinen Projektanforderungen entspricht. Dieses Tool ist für Entwickler gedacht, die Clients wie Cursor oder Claude Desktop nutzen, um den Integrationsprozess mit Backend-Services zu automatisieren.
Nutzer können den Server über uvx oder pip einrichten und die erforderlichen Credentials über Umgebungsvariablen, eine .env-Datei oder eine .yapi-mcp.json Config bereitstellen. Die Authentifizierung unterstützt sowohl Project Open Tokens als auch Login-JWTs via Cookies wie _yapi_token und _yapi_uid. Der Server enthält spezifische Tools wie yapi_parse_url, um Projektdetails aus einem Web-Link zu extrahieren, yapi_list_interfaces zum Suchen von Endpoints und yapi_get_interface, um vollständige JSON-Definitionen für eine einzelne API abzurufen.
Was du damit machen kannst
- 1API-Dokumentation aus URLs parsenEin Agent kann die Base URL und Project IDs direkt aus einem kopierten YApi-Weblink extrahieren.
- 2Verfügbare Endpoints suchen und auflistenEin Entwickler kann eine KI bitten, spezifische Interfaces innerhalb eines großen YApi-Projektkatalogs zu finden.
- 3Client-Code aus Schemas generierenEin KI-Agent kann vollständige JSON-Definitionen abrufen, um Client-Logik zu implementieren, die der API-Spezifikation entspricht.
- 4Server-Credentials dynamisch konfigurierenNutzer können die Verbindungseinstellungen während einer Session aktualisieren, ohne den gesamten MCP-Prozess neu zu starten.
Geschrieben aus dem README des Projekts. Jeder Use Case wurde gegen ein Zitat daraus geprüft.
So installierst du YApi MCP
Formate geprüft am 10. Nov. 2026Zu Cursor hinzufügenZu Goose hinzufügenYApi MCP in Claude Code installieren
$ claude mcp add --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp -- uvx contextdong-yapi-mcpYApi MCP in Cursor installieren
~/.cursor/mcp.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}YApi MCP in VS Code installieren
.vscode/mcp.json
{
"servers": {
"yapi-mcp": {
"type": "stdio",
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}YApi MCP in VS Code CLI installieren
$ code --add-mcp '{"name":"yapi-mcp","type":"stdio","command":"uvx","args":["contextdong-yapi-mcp"],"env":{"YAPI_TOKEN":"<YOUR_YAPI_TOKEN>"}}'YApi MCP in Claude Desktop installieren
claude_desktop_config.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}YApi MCP in Codex installieren
$ codex mcp add yapi-mcp --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' -- uvx contextdong-yapi-mcpYApi MCP in Codex config.toml installieren
~/.codex/config.toml
[mcp_servers.yapi-mcp] command = "uvx" args = ["contextdong-yapi-mcp"] [mcp_servers.yapi-mcp.env] YAPI_TOKEN = "<YOUR_YAPI_TOKEN>"
YApi MCP in Gemini CLI installieren
$ gemini mcp add -s user -e 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp uvx -- contextdong-yapi-mcpYApi MCP in Gemini settings.json installieren
~/.gemini/settings.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}Konfiguration
YAPI_TOKENErforderlichSecretLogin JWT or project open token
YAPI_BASE_URLYApi host URL, e.g. https://yapi.example.com
YAPI_UIDOptional uid for login JWT cookie auth
| Name | Beschreibung | Typ |
|---|---|---|
| YAPI_TOKEN | Login JWT or project open token | ErforderlichSecret |
| YAPI_BASE_URL | YApi host URL, e.g. https://yapi.example.com | |
| YAPI_UID | Optional uid for login JWT cookie auth |
Automatisierte Checks
Geluften am 14. Nov. 2026Vollständiger Bericht →Unsere automatisierten Checks bestanden. Das ist kein Security-Audit: Lies den Code und gib dem Server nur den minimal notwendigen Zugriff. Wie die Checks funktionieren
- Source Repository verknüpft und erreichbarcontextdong/yapi-mcp is public and reachablegithub.com/contextdong/yapi-mcp ↗Bestanden
- Paket nennt dieses Repository als Quellecontextdong-yapi-mcp names contextdong/yapi-mcp as sourcepypi.org/project/contextdong-yapi-mcp/ ↗Bestanden
- Build-Provenienz (Sigstore-Attestierung)No build attestation published for this releaseNicht geprüft
- Open Source Lizenz (OSI)MITspdx.org/licenses/MIT.html ↗Bestanden
- Commit oder Release im letzten JahrLast commit or release 2026-11-02github.com/contextdong/yapi-mcp ↗Bestanden
- OpenSSF ScorecardNicht geprüft
- Package-Name ähnelt keinem populären PackageNo popular package one edit away from contextdong-yapi-mcpBestanden
- Keine kritischen Advisories im Paket oder seinen Abhängigkeiten32 resolved dependencies checked; no critical advisoryosv.dev ↗Bestanden
- Keine versteckten Anweisungen an das Modell0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersBestanden
- Destruktive Tools sind markiertNicht geprüft
- Remote-Endpoint beantwortet den MCP-HandshakeNicht geprüft
README
Auf GitHub ansehenYapi-Mcp
从粘贴的 YApi 项目地址拉取接口文档(JSON 请求 / JSON 响应),供编码 Agent 自动理解并对接客户端项目的 MCP Server。
功能
- 解析 YApi 页面 URL →
base_url/project_id/interface_id - 列出 / 搜索接口,导出目录
- 拉取归一化后的请求与响应 JSON(JSON Schema / 示例)
- 鉴权:登录 JWT(Cookie
_yapi_token+_yapi_uid)或项目 open token - 动态凭证:环境变量、
.env、.yapi-mcp.json、运行时yapi_configure、或工具参数
快速接入
Cursor / Claude Desktop MCP
{
"mcpServers": {
"yapi": {
"command": "uvx",
"args": ["--from", "contextdong-yapi-mcp", "yapi-mcp"],
"env": {
"YAPI_BASE_URL": "https://yapi.example.com",
"YAPI_TOKEN": "YOUR_LOGIN_JWT_OR_PROJECT_OPEN_TOKEN"
}
}
}
}
从 Git 安装(不经 PyPI):
{
"mcpServers": {
"yapi": {
"command": "uvx",
"args": [
"--from",
"git+https://github.com/ContextDong/Yapi-Mcp",
"yapi-mcp"
],
"env": {
"YAPI_BASE_URL": "https://yapi.example.com",
"YAPI_TOKEN": "YOUR_TOKEN"
}
}
}
}
或使用 pip:
pip install contextdong-yapi-mcp
# 或: pip install git+https://github.com/ContextDong/Yapi-Mcp
配置凭证(仓库内不存放密钥)
优先级从高到低:
- 工具参数(
token、base_url) - 运行时
yapi_configure(仅当前 MCP 进程内存) - 环境变量 /
.env(YAPI_BASE_URL、YAPI_TOKEN、YAPI_UID、YAPI_COOKIE) - 配置文件
.yapi-mcp.json,或YAPI_MCP_CONFIG指向的路径
示例:
cp .env.example .env
cp .yapi-mcp.example.json .yapi-mcp.json
| 变量 | 说明 |
|---|---|
YAPI_BASE_URL |
YApi 主机,如 https://yapi.example.com |
YAPI_TOKEN |
登录 JWT 或 项目 open token |
YAPI_UID |
可选;登录 JWT 一般会自动解析 uid |
YAPI_COOKIE |
可选;原始 Cookie 头覆盖 |
YAPI_MCP_CONFIG |
可选;JSON 配置文件路径 |
切勿提交 .env、.yapi-mcp.json 或真实 token。
工具列表
| 工具 | 用途 |
|---|---|
yapi_configure / yapi_get_config |
动态配置 / 查看非敏感配置 |
yapi_parse_url |
从页面 URL 解析主机与 id |
yapi_get_project |
项目元信息 |
yapi_list_interfaces |
可搜索的接口索引 |
yapi_get_interface |
单个接口完整 JSON 定义(便于写客户端) |
yapi_export_catalog |
导出目录(可选详情) |
Agent 用法
在对话中粘贴项目地址:
根据 https://yapi.example.com/project/123/interface/api/ 对接登录相关接口
Agent 应先配置凭证(如需要),再列表 / 拉详情,最后按目标工程现有风格实现客户端。
可选 Skill:.cursor/skills/yapi-api-client/SKILL.md
本地开发
python -m pip install -e ".[dev]"
python -m pytest
python -m yapi_mcp.server
MCP Registry
- 官方名:
io.github.ContextDong/yapi-mcp - PyPI 包:
contextdong-yapi-mcp(uvx/ 命令yapi-mcp) - 说明:短名
yapi-mcp在 PyPI 上已被其他项目占用
License
MIT
YApi MCP Fragen
Wie füge ich YApi MCP zu Claude Code hinzu?
Führe claude mcp add --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp -- uvx contextdong-yapi-mcp in deinem Terminal aus. Füge --scope user hinzu, damit der Server in jedem Projekt verfügbar ist.
Wie füge ich YApi MCP zu Cursor hinzu?
Öffne ~/.cursor/mcp.json und füge den Server unter mcpServers hinzu, mit der Cursor-Config aus dem Installationsabschnitt oben.
Wie kann ich mich bei YApi authentifizieren?
Du kannst dich entweder über ein Login-JWT (via Cookie _yapi_token und _yapi_uid) oder über einen Project Open Token authentifizieren.
Kann der Server YApi-URLs direkt parsen?
Ja, der Server enthält ein Tool, um YApi-Seiten-URLs in die Base URL, die Project ID und die Interface ID zu zerlegen.