Apifox MCP Server

🚀 Apifox MCP サーバー

Apifox MCP サーバーを使用すると、Apifox プロジェクト内のインターフェースドキュメントをデータソースとして、Cursor などの AI プログラミング対応の IDE ツールに提供できます。これにより、AI がプロジェクトに対応するインターフェースドキュメントデータに直接アクセスできるようになります。

開発者は、AI アシスタントを通じて、インターフェースドキュメントに基づいたコードの生成や修正、インターフェースドキュメント内容の検索などの作業を行うことができます。このインターフェースドキュメントデータを使って、AI にさらに強力なことをさせる方法については、あなたの想像力とチームの創造力を存分に発揮してみてください！

🚀 クイックスタート

MCP をインストールして設定すると、Apifox MCP サーバーは自動的に Apifox のプロジェクト全体のインターフェースドキュメントデータを読み取り、ローカルコンピューターにキャッシュします。AI は MCP を通じて、プロジェクト内のすべてのインターフェースドキュメントデータを読み取ることができます。

あなたは、AI に API ドキュメントを使って何をしたいかを指示するだけです。例えば：

1. “MCP を通じて API ドキュメントを取得し、Product とその関連モデルの定義コードを生成する”
2. “API ドキュメントに基づいて、Product DTO に新しいフィールドを追加する”
3. “API ドキュメントに基づいて、Product クラスの各フィールドにコメントを追加する”
4. “API ドキュメントに基づいて、インターフェース /users に関連するすべての MVC コードを生成する”

注意：インターフェースドキュメントデータはデフォルトでローカルにキャッシュされます。Apifox 内のデータが更新された場合は、AI にインターフェースドキュメントデータを更新するように指示してください。そうしないと、AI が読み取るデータが最新のものでない可能性があります。

📦 インストール

前提条件

• Node.js 環境がインストールされていること（バージョン番号 >= 18、最新の LTS バージョンの使用を推奨）
• 少なくとも 1 つの MCP 対応 IDE：
  • Cursor
  • VSCode + Cline プラグイン

インストール手順

1. Apifox で Access Token を生成する a. Apifox を開き、ページ右上のアイコンにマウスを重ね、「アカウント設定 -> API アクセストークン」をクリックします。 b. 新しい API アクセストークンを作成します。具体的な操作方法はヘルプドキュメントを参照してください。 c. API アクセストークンを取得したら、以下の設定ファイル内の <access-token> を置き換えます。

2. Apifox プロジェクト ID を取得する a. Apifox で対象のプロジェクトを開きます。 b. 左側のサイドバーで「プロジェクト設定」をクリックし、「基本設定」でプロジェクト ID を確認します。 c. プロジェクト ID を以下の設定ファイル内の <project-id> に置き換えます。

3. インストールと設定

   • ほとんどの場合、以下のコマンドを実行します。

   npm install -g apifox-mcp-server
   

   その後、必要に応じて以下のコマンドを実行してサーバーを起動します。

   apifox-mcp-server --project-id=<your-project-id>
   

   • プライベートデプロイを使用する場合は、--apifox-api-base-url パラメーターを追加し、Apifox サービスのアドレスを指定します。

4. Swagger/OAS ファイルを直接読み取る Apifox プロジェクトを使用しない場合は、Swagger または OpenAPI ドキュメントファイルを直接指定できます。

   apifox-mcp-server --oas https://example.com/swagger.json
   

❓ ヘルプとサポート

Apifox MCP サーバーは現在まだ内部テスト段階です。ご意見やアイデアをいただけると幸いです。以下の方法でご連絡ください。