Next MCP Server

🚀 Next.js MCP サーバー

Next.js MCP サーバーは、Next.js アプリケーションの API ルート情報を分析・抽出するツールです。これにより、API の詳細な情報を把握することができます。

🚀 クイックスタート

デモ

インストール

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 設定に依存します。

✨ 主な機能

• get-routers-info

このルーター分析ツールは、Next.js アプリケーションのディレクトリ構造をスキャンし、すべての API ルートの情報を抽出します。抽出される情報には以下が含まれます。

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

📦 インストール

npm install next-mcp-server

または、pnpm を使用する場合:

pnpm add next-mcp-server

💻 使用例

基本的な使用法

コマンドライン

npm run build
node dist/index.js

Docker

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

cursor の設定

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

高度な使用法

出力例

[
  {
    "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 ルートの構造化された表現を返します。

制限事項

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

📄 ライセンス

MIT