Next.js API Scanner MCP server

Next.js MCP Server provides a powerful tool for analyzing your Next.js application's API routes. It extracts detailed information about routes, methods, parameters, and schemas, making it easier to understand and document your API structure.

Features

• Router Analysis: Scans your Next.js app directory structure and extracts comprehensive information about all API routes, including:
  • API paths
  • HTTP methods (GET, POST, PUT, DELETE, etc.)
  • Request parameters
  • Status codes
  • Request and response schemas

Installation

You can install the package using npm:

npm install next-mcp-server

Or if you prefer using pnpm:

pnpm add next-mcp-server

Usage

Command Line

To run the MCP server directly:

npm run build
node dist/index.js

Docker

You can also run the server using Docker:

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

Integration with Cursor

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

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

Note that the url may vary based on your .env settings within the project.

Output Format

The tool generates detailed information about each route in the following format:

[
  {
    "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]
      }
    ]
  }
]

Limitations

• Due to filesystem access requirements, the tool won't work if hosted over a network
• Only supports Next.js App router projects

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "next-js" '{"url":"http://localhost:4857/sse"}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

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

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect