Yapi MCP Server

🚀 YAPI MCP サーバー

このサーバーは、YAPI インスタンスと相互作用する Model Context Protocol (MCP) サーバーです。大型言語モデル (LLMs) が、あなたの YAPI プロジェクトから API ドキュメントの詳細情報を取得できるようにします。

✨ 主な機能

• 特定のプロジェクト内のインターフェースカテゴリとその基本的なインターフェース情報をリストする。
• ID で特定のインターフェースの詳細情報を取得する。

🛠️ ツール

yapi_list_interfaces

• 特定の YAPI プロジェクトのすべてのインターフェースカテゴリとそれに含まれるインターフェースをリストします。
• 入力:
  • project_token (文字列): YAPI プロジェクトのトークン（YAPI プロジェクト設定 -> トークンで見つけることができます）。
• 戻り値: カテゴリ別の配列を含む JSON 文字列。各カテゴリには、簡略化されたインターフェースオブジェクトのリスト（id、タイトル、パス、メソッド、ステータス）があります。

yapi_get_interface_details

• ID に基づいて特定の YAPI インターフェースの詳細情報を取得します。
• 入力:
  • project_token (文字列): YAPI プロジェクトのトークン。
  • interface_id (数値): 特定の YAPI インターフェースの ID（YAPI でインターフェースを表示するときの URL で見つけることができます）。
• 戻り値: 詳細なインターフェース情報（リクエスト/レスポンスパラメータ、ヘッダー、本文モードなど）を含む JSON 文字列。

📦 インストール

前提条件

1. 稼働中の YAPI インスタンス。
2. 相互作用する YAPI プロジェクトのプロジェクトトークンへのアクセス。このトークンは、YAPI プロジェクトの「設定」 -> 「トークン」セクションで見つけることができます。
3. サーバーを実行するか、Docker イメージを構築するマシンに Node.js と npm をインストールする。

設定

このサーバーは、YAPI_URL 環境変数を通じて YAPI インスタンスの基本 URL を設定する必要があります。

Claude Desktop の使用

以下の内容を claude_desktop_config.json に追加します。

NPX

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi"
      ],
      "env": {
        "YAPI_URL": "http://your-yapi-instance.com"
        // デフォルトトークンをハードコードしたい場合（安全ではなく、ツールを通じて渡すことをおすすめ）:
        // "YAPI_PROJECT_TOKEN": "YOUR_DEFAULT_PROJECT_TOKEN"
      }
    }
  }
}