Next.js API Scanner

🚀 Next.js MCP Server

The Next.js MCP Server is a tool that scans your Next.js application directory structure and extracts information about all API routes, providing detailed insights into your application's routing.

🚀 Quick Start

The Next.js MCP Server offers a convenient way to analyze API routes in your Next.js application. You can quickly get started by following the installation and usage steps below.

✨ Features

• get-routers-info

The route analyzer scans your Next.js application directory structure 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

You can install the next-mcp-server package using either npm or pnpm:

npm install next-mcp-server

Or if you use 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

Advanced Usage

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

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

Note that the url may vary depending on the settings in your project's .env file.

📚 Documentation

Output

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]
      }
    ]
  }
]

Development

Run Tests

npm run test

Run the MCP Server Locally

npm run build
node dist/index.js 

Run from node_modules (after npm i)

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

Run the Playground

pnpm --filter playground dev

How It Works

The tool:

1. Scans your Next.js application directory structure 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 will not work if hosted on a network.
2. Only supports Next.js App route projects.

📄 License

This project is licensed under the MIT License.