Next.js API Scanner

🚀 Next.js MCP サーバー

Next.js MCP サーバーは、Next.js アプリケーションの API ルートに関する詳細情報を抽出するツールです。これにより、API の構造や動作を容易に把握することができます。

🚀 クイックスタート

このセクションでは、Next.js MCP サーバーの基本的な使い方を説明します。

✨ 主な機能

• get-routers-info

ルート分析器は、Next.js アプリケーションのディレクトリ構造をスキャンし、すべての API ルートの情報を抽出します。具体的には以下の情報が取得されます：

• API パス
• HTTP メソッド（GET、POST、PUT、DELETE など）
• リクエストパラメータ
• ステータスコード
• リクエストとレスポンスのパターン

📦 インストール

以下のコマンドを使用して、Next.js MCP サーバーをインストールできます。

npm を使用する場合

npm install next-mcp-server

pnpm を使用する場合

pnpm add next-mcp-server

💻 使用例

コマンドラインでの使用

以下のコマンドを実行して、MCP サーバーを起動できます。

npm run build
node dist/index.js

Docker を使用する場合

docker build -t mcp/next -f Dockerfile .
docker run mcp/next -d

Cursor での使用

~/.cursor または [projectDir]/.cursor ディレクトリに mcp.json ファイルを作成し、以下のように設定します。

{
  "mcpServers": {
    "next.js": {
      "url": "http://localhost:4857/sse"
    }
  }
}

ここでの url は、プロジェクトの .env 設定によって異なる場合があります。

出力例

このツールは、各ルートの詳細情報を生成します。以下は出力の例です。

[
  {
    "filePath": "/path/to/your/app/api/test/route.ts",
    "implementationPath": "/path/to/your/app/api/test/route.ts",
    "apiPath": "/api/test",
    "handlers": [
      {
        "method": "GET",
        "path": "/api/test",
        "functionSignature": "export async function GET(request: Request)",
        "description": "获取测试数据",
        "parameters": [],
        "statusCodes": [200]
      },
      {
        "method": "POST",
        "path": "/api/test",
        "functionSignature": "export async function POST(request: Request)",
        "description": "创建测试数据",
        "parameters": [],
        "requestBodySchema": "{ name: string }",
        "statusCodes": [201, 400]
      }
    ]
  }
]

🔧 技術詳細

このツールは以下の手順で動作します：

1. Next.js アプリケーションのディレクトリ構造をスキャンして、ルートファイルを探します。
2. 各ルートファイルを分析して、HTTP メソッド、パス、パラメータなどの情報を抽出します。
3. コメントからドキュメント情報を抽出します。
4. すべての API ルートの構造化された表現を返します。

📚 ドキュメント

開発に関する情報

テストの実行

npm run test

ローカルでの MCP サーバーの実行

npm run build
node dist/index.js 

node_modules からの実行（npm i 後）

node node_modules/next-mcp-server/dist/index.js

Playground の実行

pnpm --filter playground dev

制限事項

1. ファイルシステムへのパスアクセスの性質上、ネットワーク上でホストされている場合は動作しません。
2. Next.js App ルートプロジェクトのみをサポートしています。

📄 ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。