Yapay zeka ajanlarının istemci projelerini anlamasına ve entegre olmasına yardımcı olmak için proje URL'lerinden YApi JSON API dokümantasyonunu çeker.
Ayrıca bilinen adı ContextDong/Yapi-Mcp, yapi-mcp, contextdong-yapi-mcp
- Yıldızlar
- 0
- Araçlar
- —
- İndirmeler, 30 gün
- —
- En son sürüm
- 0.1.0
- Son commit
- 2 Kas 2026
- Lisans
- MIT
YApi MCP nedir?
Yapay zeka ajanlarının istemci projelerini anlamasına ve entegre olmasına yardımcı olmak için proje URL'lerinden YApi JSON API dokümantasyonunu çeker.
Özet, projenin README dosyasından oluşturuldu
YApi MCP sunucusu hakkında
YApi MCP, yapay zeka kodlama ajanlarının YApi'de saklanan API dokümantasyonuna erişmesini ve bunları anlamasını sağlar. Sunucu, YApi örneğinize bağlanarak ajanların JSON istek ve yanıt şemalarını çekmesine olanak tanır; bu da mevcut proje gereksinimlerinizle eşleşen istemci tarafı kodları yazmalarına yardımcı olur. Bu araç, arka uç servisleriyle entegrasyon sürecini otomatikleştirmek isteyen ve Cursor veya Claude Desktop gibi istemciler kullanan geliştiriciler için tasarlanmıştır.
Kullanıcılar sunucuyu uvx veya pip kullanarak kurabilir; gerekli kimlik bilgilerini ortam değişkenleri, bir .env dosyası veya bir .yapi-mcp.json yapılandırma dosyası aracılığıyla sağlayabilirler. Kimlik doğrulama, hem proje açık token'larını hem de _yapi_token ve _yapi_uid gibi çerezleri kullanan login JWT'lerini destekler. Sunucu, bir web bağlantısından proje ayrıntılarını çıkarmak için yapi_parse_url, uç noktaları aramak için yapi_list_interfaces ve tek bir API için tam JSON tanımlarını almak için yapi_get_interface gibi özel araçlar içerir.
Neler yapabilirsiniz
- 1URL'lerden API dokümantasyonunu ayrıştırınBir ajan, yapıştırılan bir YApi web bağlantısından base URL ve proje ID'lerini doğrudan çıkarabilir.
- 2Mevcut uç noktaları arayın ve listeleyinBir geliştirici, geniş bir YApi proje kataloğu içindeki belirli arayüzleri bulması için bir yapay zekadan talepte bulunabilir.
- 3Şemalardan istemci kodu oluşturunBir yapay zeka ajanı, API spesifikasyonuna uygun istemci tarafı mantığını uygulamak için tam JSON tanımlarını alabilir.
- 4Sunucu kimlik bilgilerini dinamik olarak yapılandırınKullanıcılar, tüm MCP sürecini yeniden başlatmadan bir oturum sırasında bağlantı ayarlarını güncelleyebilirler.
Projenin README dosyasından alınmıştır. Her kullanım durumu, oradaki bir alıntı ile kontrol edilir.
YApi MCP nasıl yüklenir
Biçimler 10 Kas 2026 tarihinde doğrulandıCursor'a ekleGoose'a ekleYApi MCP'yi Claude Code içine yükleyin
$ claude mcp add --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp -- uvx contextdong-yapi-mcpYApi MCP'yi Cursor içine yükleyin
~/.cursor/mcp.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}YApi MCP'yi VS Code içine yükleyin
.vscode/mcp.json
{
"servers": {
"yapi-mcp": {
"type": "stdio",
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}YApi MCP'yi VS Code CLI içine yükleyin
$ code --add-mcp '{"name":"yapi-mcp","type":"stdio","command":"uvx","args":["contextdong-yapi-mcp"],"env":{"YAPI_TOKEN":"<YOUR_YAPI_TOKEN>"}}'YApi MCP'yi Claude Desktop içine yükleyin
claude_desktop_config.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}YApi MCP'yi Codex içine yükleyin
$ codex mcp add yapi-mcp --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' -- uvx contextdong-yapi-mcpYApi MCP'yi Codex config.toml içine yükleyin
~/.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'yi Gemini CLI içine yükleyin
$ gemini mcp add -s user -e 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp uvx -- contextdong-yapi-mcpYApi MCP'yi Gemini settings.json içine yükleyin
~/.gemini/settings.json
{
"mcpServers": {
"yapi-mcp": {
"command": "uvx",
"args": [
"contextdong-yapi-mcp"
],
"env": {
"YAPI_TOKEN": "<YOUR_YAPI_TOKEN>"
}
}
}
}Yapılandırma
YAPI_TOKENGerekliGizliLogin JWT or project open token
YAPI_BASE_URLYApi host URL, e.g. https://yapi.example.com
YAPI_UIDOptional uid for login JWT cookie auth
| Ad | Açıklama | Sunucu |
|---|---|---|
| YAPI_TOKEN | Login JWT or project open token | GerekliGizli |
| YAPI_BASE_URL | YApi host URL, e.g. https://yapi.example.com | |
| YAPI_UID | Optional uid for login JWT cookie auth |
Otomatik kontroller
Çalıştırıldı 14 Kas 2026Tam rapor →Otomatik kontrollerimizden geçti. Bu bir güvenlik denetimi değildir: kodu okuyun ve sunucuya ihtiyaç duyduğu en dar erişimi verin. Kontroller nasıl çalışır
- Kaynak deposu bağlantılı ve erişilebilircontextdong/yapi-mcp is public and reachablegithub.com/contextdong/yapi-mcp ↗Geçti
- Paket, bu depoyu kaynağı olarak gösteriyorcontextdong-yapi-mcp names contextdong/yapi-mcp as sourcepypi.org/project/contextdong-yapi-mcp/ ↗Geçti
- Derleme kökeni (Sigstore onayı)No build attestation published for this releaseKontrol edilmedi
- Açık kaynak lisansı (OSI)MITspdx.org/licenses/MIT.html ↗Geçti
- Son bir yıl içinde commit veya sürüm mevcutLast commit or release 2026-11-02github.com/contextdong/yapi-mcp ↗Geçti
- OpenSSF ScorecardKontrol edilmedi
- Paket adı popüler bir pakete yakın değilNo popular package one edit away from contextdong-yapi-mcpGeçti
- Pakette veya bağımlılıklarında kritik uyarı yok32 resolved dependencies checked; no critical advisoryosv.dev ↗Geçti
- Modele yönelik gizli talimat yok0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersGeçti
- Yıkıcı araçlar etiketlenmişKontrol edilmedi
- Uzak uç nokta MCP el sıkışmasına yanıt veriyorKontrol edilmedi
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 soruları
YApi MCP'yi Claude Code'a nasıl eklerim?
Terminalinizde claude mcp add --env 'YAPI_TOKEN=<YOUR_YAPI_TOKEN>' yapi-mcp -- uvx contextdong-yapi-mcp komutunu çalıştırın. Her projede kullanılabilir olması için --scope user ekleyin.
YApi MCP'yi Cursor'a nasıl eklerim?
~/.cursor/mcp.json dosyasını açın ve yukarıdaki yükleme bölümünde gösterilen Cursor yapılandırmasını kullanarak sunucuyu mcpServers altına ekleyin.
YApi ile nasıl kimlik doğrulaması yapabilirim?
Bir login JWT (Cookie _yapi_token ve _yapi_uid aracılığıyla) veya bir proje açık token'ı kullanarak kimlik doğrulaması yapabilirsiniz.
Sunucu YApi URL'lerini doğrudan ayrıştırabilir mi?
Evet, sunucu YApi sayfa URL'lerini base URL, proje ID'si ve arayüz ID'sine dönüştürmek için bir araç içerir.