Apifox MCP Server

🚀 ApiFox MCP サーバー

このサーバーは、Model Context Protocol (MCP) に基づく ApiFox インターフェースサーバーです。ApiFox のインターフェース情報の取得と管理に使用されます。Cursor で MCP サービスを構成することで、対応するインターフェースモジュール情報を取得して大規模モデルに返し、Cursor がインターフェース情報を通じてビジネスロジックを実装するのを支援します。

✨ 主な機能

• MCP プロトコルを通じて ApiFox インターフェース情報を取得することができます。
• HTTP サービスと CLI コマンドラインの 2 種類の使用方法を提供します。
• TypeScript で開発されており、型安全性が保証されます。
• 環境変数による設定をサポートしています。

🚀 クイックスタート

インストールと実行

npx @wangmhaha/apifox-mcp-server@latest --apifox-api-key=<your-apifox-api-key> --project=<your-project-id>

Cursor を SSE で MCP サーバーに接続する設定

サーバーは設定されたポート（デフォルトは 3000）で起動します。

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
}

推奨：JSON 設定ファイルを使用した設定

Cursor MCP 設定ファイルに以下の内容を追加することで、apifox-mcp-server サーバーを設定できます。

"apifox-mcp-server": {
    "command": "npx",
    "args": ["-y", "@wangmhaha/apifox-mcp-server@latest", "--local"],
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
}

ローカルソースからの実行

コードの取得と依存関係のインストール

pnpm install

ビルド

pnpm build

実行

pnpm start:http

設定

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
}

command モードでの実行

"apifox-mcp-server": {
    "command": "node",
    "args": [
      "<you-local-path>/build/index.js",
      "--local",
    ],
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
},

環境変数の設定

MCP 設定ファイルで env 環境変数を設定しない場合は、ローカル環境変数を設定してください。 プロジェクトのルートディレクトリで .env.example ファイルを .env ファイルに変更し、以下の内容を設定します。

APIFOX_API_KEY=your_api_key_here
PROJECT_ID=your_project-ID
PORT=3000  # 任意、デフォルトは 3000

🔧 技術詳細

• Node.js
• TypeScript
• Express.js
• Model Context Protocol SDK
• Zod（データ検証）

📄 ライセンス

ISC License