YApi MCP

Yapi-Mcp

貼り付けた YApi プロジェクトの URL からインターフェースドキュメント（JSON リクエスト／JSON レスポンス）を取得し、コーディングエージェントがクライアントプロジェクトを自動的に理解して連携できるようにする MCP サーバーです。

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

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

認証情報の設定（リポジトリ内に秘密情報を保存しない）

優先順位の高い順：

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 で指定したパス

例：

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	カタログのエクスポート（詳細は任意）

エージェントの使い方

会話にプロジェクトの URL を貼り付けます：

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

エージェントは必要に応じて最初に認証情報を設定し、次に一覧表示／詳細の取得を行い、最後に対象プロジェクトの既存のスタイルに合わせてクライアントを実装してください。

任意の 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