YApi MCP

io.github.ContextDong由 GitHub 帳號 ContextDong 發布v0.1.0更新於 Nov 3, 2026

從專案URL取得YApi JSON API文件，用於agent客戶端整合。

AI 翻譯由 AI 模型根據下方的原文描述翻譯，可能有誤。

原文描述

Fetch YApi JSON API docs from a project URL for agent client integration.

已驗證STDIO僅桌面

概覽

YApi 的本機 MCP 服務；無需登入；STDIO。

暫無 AI 概覽：以下資訊來自註冊中心條目和服務本身。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 YApi MCP，將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only，透過 STDIO。 STDIO 服務會啟動本機處理程序，因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

Yapi-Mcp

从粘贴的 YApi 项目地址拉取接口文档（JSON 请求 / JSON 响应），供编码 Agent 自动理解并对接客户端项目的 MCP Server。

English

功能

  • 解析 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

json
{  "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）：

json
{  "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：

bash
pip install contextdong-yapi-mcp# 或: pip install git+https://github.com/ContextDong/Yapi-Mcp

配置凭证（仓库内不存放密钥）

优先级从高到低：

  1. 工具参数（token、base_url）
  2. 运行时 yapi_configure（仅当前 MCP 进程内存）
  3. 环境变量 / .env（YAPI_BASE_URL、YAPI_TOKEN、YAPI_UID、YAPI_COOKIE）
  4. 配置文件 .yapi-mcp.json，或 YAPI_MCP_CONFIG 指向的路径

示例：

bash
cp .env.example .envcp .yapi-mcp.example.json .yapi-mcp.json
变量说明
YAPI_BASE_URLYApi 主机，如 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 用法

在对话中粘贴项目地址：

text
根据 https://yapi.example.com/project/123/interface/api/ 对接登录相关接口

Agent 应先配置凭证（如需要），再列表 / 拉详情，最后按目标工程现有风格实现客户端。

可选 Skill：.cursor/skills/yapi-api-client/SKILL.md

本地开发

bash
python -m pip install -e ".[dev]"python -m pytestpython -m yapi_mcp.server

MCP Registry

  • 官方名：io.github.ContextDong/yapi-mcp
  • PyPI 包：contextdong-yapi-mcp（uvx / 命令 yapi-mcp）
  • 说明：短名 yapi-mcp 在 PyPI 上已被其他项目占用

License

MIT

來源：README.md，提交 44e9431

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包，因此其工具未知。

版本歷史

1
  1. v0.1.0最新Nov 3, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度，依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價，也不表示伺服器安全或目前可用：可連通性是帶日期的檢查結果，評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手；SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭，或保持端點能夠回應探測，以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list，或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分