apifox-mcp MCP 服务器 について
Apifox MCP Serverは、AIアシスタントをApifoxプロジェクト内のAPI定義に接続します。リクエストパラメーターやレスポンススキーマを含む、構造化されたエンドポイント仕様を返します。
主な機能
- 01エンドポイント定義の取得
- 02HTTPメソッドとヘッダーの返却
- 03パス・クエリ・ボディパラメーターの提供
- 04レスポンスボディスキーマの取得
活用シーン
- 01コーディング中にエンドポイントを確認
- 02TypeScriptの入出力型を生成
- 03仕様をもとにAPI呼び出しを作成
MCP 対応
stdioで動作するMCPサーバーとして、ApifoxのプロジェクトIDとエンドポイントIDを使い、API仕様を取得するツールをクライアントに提供します。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
ツール
1掲載時のツール一覧 · 3 週間前に更新
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| projectId | number | はい | Apifox プロジェクト ID |
| endpointId | number | はい | API Endpoint の ID |
詳細
Apifox MCP サーバー
Stdio を使用して実装されたモデルコンテキストプロトコル(Model Context Protocol)サーバーです。AI アシスタントと Apifox プラットフォームの API データをシームレスに橋渡しすることを目的としています。
AI アシスタントが標準化されたプロトコルを通じて、Apifox プロジェクトで定義した API インターフェースの詳細を直接リアルタイムに取得して理解できるようにし、開発効率とコード生成の品質を大幅に向上させます。
✨ 機能
ツール
get_api_endpoint_info- Apifox のインターフェース定義情報を取得します- リクエストパラメーター
projectId: Apifox プロジェクトの一意の識別子です。endpointId: 対象 API エンドポイントの一意の識別子です。
- 返されるデータ
- API 仕様(Specification)全体を含む、構造化された JSON オブジェクトです。例:
- HTTP リクエストメソッド(Method)
- リクエストヘッダー(Request Headers)
- パス、クエリ、リクエストボディのパラメーター(Parameters: Path, Query, Body)
- レスポンスボディのスキーマ(Response Body Schema)
- レスポンスヘッダー(Response Headers)
- API 仕様(Specification)全体を含む、構造化された JSON オブジェクトです。例:
- リクエストパラメーター
🚀 インストールと設定
Cursor でこのサーバーを使用するには、以下のサーバー設定を追加してください。
{
"mcpServers": {
"Apifox-MCP": {
"command": "npx",
"args": ["@juzi965/apifox-mcp-server"],
"env": {
"APIFOX_AUTH": "..."
}
}
}
}
環境変数
このサーバーでは、以下の環境変数が必要です。
APIFOX_AUTH: Apifox の認証トークン
💡 使用方法
共有リンクを Cursor にコピーして、以下を作成してもらいます。
- 入力パラメーターの TS 型定義
- 出力パラメーターの TS 型定義
- インターフェース呼び出しメソッドの定義
🛠️ デバッグ
MCP サーバーは標準入出力(stdio)で通信するため、デバッグが難しい場合があります。以下のコマンドで起動できるMCP Inspectorの使用をおすすめします。
npm run inspector
Inspector が URL を表示します。その URL にブラウザーからアクセスすると、デバッグツールを利用できます。
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。