Next MCP Server

🚀 Next.js MCP Server

Next.js MCP Server is a tool that analyzes API routes in Next.js applications, providing detailed information about each route.

🚀 Quick Start

You can quickly start using the Next.js MCP Server by following the installation and usage steps below.

✨ Features

• get-routers-info

This router analysis tool scans the directory structure of your Next.js application and extracts information about all API routes, including:

• API path
• HTTP methods (GET, POST, PUT, DELETE, etc.)
• Request parameters
• Status codes
• Request and response patterns

📦 Installation

npm install next-mcp-server

Or if you are using pnpm:

pnpm add next-mcp-server

💻 Usage Examples

Basic Usage

Command Line

You can directly run the MCP server:

npm run build
node dist/index.js

Docker

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

For Cursor usage, you can define a mcp.json file under ~/.cursor or [projectDir]/.cursor:

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

Here, the url depends on the settings in the .env file in your project directory.

Advanced Usage

The tool generates detailed information for each route:

[
  {
    "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": "Get test data",
        "parameters": [],
        "statusCodes": [200]
      },
      {
        "method": "POST",
        "path": "/api/test",
        "functionSignature": "export async function POST(request: Request)",
        "description": "Create test data",
        "parameters": [],
        "requestBodySchema": "{ name: string }",
        "statusCodes": [201, 400]
      }
    ]
  }
]

🔧 Technical Details

The tool works as follows:

1. Scans the directory structure of your Next.js application to find route files.
2. Analyzes each route file to extract information such as HTTP methods, paths, and parameters.
3. Extracts documentation information from comments.
4. Returns a structured representation of all API routes.

Limitations

1. Due to the nature of accessing the file system via paths, it cannot be used if hosted on the network.
2. Only supports Next.js App routing projects.

📄 License

MIT