프로젝트 URL에서 YApi JSON API 문서를 가져와 AI agent가 클라이언트 프로젝트를 이해하고 통합할 수 있도록 지원합니다.
다른 이름 ContextDong/Yapi-Mcp, yapi-mcp, contextdong-yapi-mcp
- 스타
- 0
- Tools
- —
- 다운로드, 30일
- —
- 최신 버전
- 0.1.0
- 마지막 커밋
- 2026년 11월 2일
- 라이선스
- MIT
YApi MCP란?
프로젝트 URL에서 YApi JSON API 문서를 가져와 AI agent가 클라이언트 프로젝트를 이해하고 통합할 수 있도록 지원합니다.
프로젝트 README에서 생성된 요약
YApi MCP server 정보
YApi MCP는 AI 코딩 agent가 YApi에 저장된 API 문서를 액세스하고 이해할 수 있는 방법을 제공합니다. YApi 인스턴스에 연결함으로써, 이 MCP server는 agent가 JSON 요청 및 응답 스키마를 가져올 수 있게 하여 기존 프로젝트 요구 사항에 맞는 클라이언트 측 코드를 작성하도록 돕습니다. 이 도구는 Cursor 또는 Claude Desktop과 같은 클라이언트를 사용하는 개발자가 백엔드 서비스와의 통합 프로세스를 자동화할 수 있도록 설계되었습니다.
사용자는 uvx 또는 pip를 사용하여 서버를 설정할 수 있으며, 환경 변수, .env 파일 또는 .yapi-mcp.json 설정 파일을 통해 필요한 인증 정보를 제공할 수 있습니다. 인증은 프로젝트 오픈 토큰과 _yapi_token 및 _yapi_uid 쿠키를 사용하는 로그인 JWT를 모두 지원합니다. 서버에는 웹 링크에서 프로젝트 세부 정보를 추출하는 yapi_parse_url, 엔드포인트를 검색하는 yapi_list_interfaces, 단일 API에 대한 전체 JSON 정의를 가져오는 yapi_get_interface와 같은 특정 도구가 포함되어 있습니다.
활용 사례
- 1URL에서 API 문서 파싱agent가 붙여넣은 YApi 웹 링크에서 base URL과 project ID를 직접 추출할 수 있습니다.
- 2사용 가능한 엔드포인트 검색 및 목록 표시개발자가 AI에게 대규모 YApi 프로젝트 카탈로그 내에서 특정 인터페이스를 찾도록 요청할 수 있습니다.
- 3스키마 기반 클라이언트 코드 생성AI agent가 전체 JSON 정의를 가져와 API 사양을 따르는 클라이언트 측 로직을 구현할 수 있습니다.
- 4서버 인증 정보 동적 구성사용자는 전체 MCP 프로세스를 재시작하지 않고 세션 중에 연결 설정을 업데이트할 수 있습니다.
프로젝트의 README를 바탕으로 작성되었습니다. 모든 활용 사례는 해당 내용의 인용문과 대조하여 확인합니다.
YApi MCP 설치 방법
형식 확인: 2026년 11월 10일Cursor에 추가Goose에 추가Claude Code에 YApi MCP 설치
$ claude mcp add --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp -- uvx contextdong-yapi-mcpCursor에 YApi MCP 설치
~/.cursor/mcp.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}VS Code에 YApi MCP 설치
.vscode/mcp.json
{
"servers": {
"yapi-mcp": {
"type": "stdio",
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}VS Code CLI에 YApi MCP 설치
$ code --add-mcp '{"name":"yapi-mcp","type":"stdio","command":"uvx","args":["contextdong-yapi-mcp"],"env":{"YAPI_TOKEN":"<YOUR_YAPI_TOKEN>"}}'Claude Desktop에 YApi MCP 설치
claude_desktop_config.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}Codex에 YApi MCP 설치
$ codex mcp add yapi-mcp --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' -- uvx contextdong-yapi-mcpCodex config.toml에 YApi MCP 설치
~/.codex/config.toml
[mcp_servers.yapi-mcp] command = "uvx" args = ["contextdong-yapi-mcp"] [mcp_servers.yapi-mcp.env] YAPI_TOKEN = "<YOUR_YAPI_TOKEN>"
Gemini CLI에 YApi MCP 설치
$ gemini mcp add -s user -e 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp uvx -- contextdong-yapi-mcpGemini settings.json에 YApi MCP 설치
~/.gemini/settings.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}구성
YAPI_TOKEN필수비밀Login JWT or project open token
YAPI_BASE_URLYApi host URL, e.g. https://yapi.example.com
YAPI_UIDOptional uid for login JWT cookie auth
| 이름 | 설명 | 유형 |
|---|---|---|
| YAPI_TOKEN | Login JWT or project open token | 필수비밀 |
| YAPI_BASE_URL | YApi host URL, e.g. https://yapi.example.com | |
| YAPI_UID | Optional uid for login JWT cookie auth |
자동 검사
2026년 11월 14일에 실행됨전체 보고서 →자동 검사를 통과했습니다. 이는 보안 감사가 아닙니다. 코드를 직접 읽고 서버에 필요한 최소한의 권한만 부여하십시오. 검사 방식
- 소스 저장소 연결 및 접근 가능contextdong/yapi-mcp is public and reachablegithub.com/contextdong/yapi-mcp ↗통과
- 패키지가 이 저장소를 소스로 명시contextdong-yapi-mcp names contextdong/yapi-mcp as sourcepypi.org/project/contextdong-yapi-mcp/ ↗통과
- 빌드 출처(Sigstore 증명)No build attestation published for this release검사되지 않음
- 오픈 소스 라이선스 (OSI)MITspdx.org/licenses/MIT.html ↗통과
- 최근 1년 내 커밋 또는 릴리스Last commit or release 2026-11-02github.com/contextdong/yapi-mcp ↗통과
- OpenSSF Scorecard검사되지 않음
- 패키지 이름이 인기 패키지와 유사하지 않음No popular package one edit away from contextdong-yapi-mcp통과
- 패키지 및 해당 종속성에 중요한 보안 권고 없음32 resolved dependencies checked; no critical advisoryosv.dev ↗통과
- 모델에 대한 숨겨진 지침 없음0 tool descriptions and the README read; no override phrases, credential paths or hidden characters통과
- 파괴적인 도구에 라벨 표시됨검사되지 않음
- 원격 엔드포인트가 MCP 핸드셰이크에 응답검사되지 않음
README
GitHub에서 보기Yapi-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 질문
YApi MCP를 Claude Code에 추가하려면 어떻게 하나요?
터미널에서 claude mcp add --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp -- uvx contextdong-yapi-mcp를 실행합니다. 모든 프로젝트에서 사용할 수 있게 하려면 --scope user를 추가합니다.
YApi MCP를 Cursor에 추가하려면 어떻게 하나요?
~/.cursor/mcp.json를 열고 mcpServers 아래에 서버를 추가합니다. 위 설치 섹션에 표시된 Cursor 구성을 사용합니다.
YApi 인증은 어떻게 하나요?
로그인 JWT(_yapi_token 및 _yapi_uid 쿠키 사용) 또는 프로젝트 오픈 토큰을 사용하여 인증할 수 있습니다.
서버에서 YApi URL을 직접 파싱할 수 있나요?
네, 서버에 YApi 페이지 URL을 base URL, project ID, interface ID로 파싱하는 도구가 포함되어 있습니다.