Next.js API Scanner
About
Scans Next.js project directories to extract API route information, validation schemas, and type definitions for automated documentation and testing workflows
Details
- Author
- vertile-ai
- Repository
- vertile-ai/next-mcp-server
- GitHub stars
- 85
- Downloads
- 443
- License
- MIT License
- Categories
- Productivity, Developer Tools, Design, Workplace, File Management, AI, Search, Infrastructure, Frontend, Knowledge Base
Jump to
- get-routers-info
The Router Analyzer scans your Next.js app directory structure and extracts information about all API routes, including:
- API paths
- HTTP methods (GET, POST, PUT, DELETE, etc.)
- Request parameters
- Status codes
- Request and response schemas
Setting up with Highlight
This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:
- Download and install Highlight from highlightai.com/download
- Navigate to the plugins tab and select "Add Custom Plugin"
-
Configure the plugin with the settings below
Plugin Name
Next.js API ScannerCommand (node, npx, python, etc.)npxArguments-
Argument 1
-y -
Argument 2
@highlight/mcp-server
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
-
Argument 1
- Enable "Start Automatically" if you want the plugin to start when Highlight launches
get-routers-info
Scans your Next.js app directory structure and extracts information about all API routes, including API paths, HTTP methods, request parameters, status codes, and request and response schemas.
Claude Desktop / Cursor
Paste into your MCP client config file to install this server.
{
"mcpServers": {
"next.js api scanner": {
"env": {},
"args": [
"-y",
"@highlight/mcp-server"
],
"command": "npx"
}
}
}Linux
{
"env": [],
"args": [
"-y",
"@highlight/mcp-server"
],
"command": "npx"
}Macos
{
"env": [],
"args": [
"-y",
"@highlight/mcp-server"
],
"command": "npx"
}Windows
{
"env": [],
"args": [
"/c",
"npx",
"-y",
"@highlight/mcp-server"
],
"command": "cmd"
}Next.js MCP Server
Demo
Features
- get-routers-info
The Router Analyzer scans your Next.js app directory structure and extracts information about all API routes, including:
- API paths
- HTTP methods (GET, POST, PUT, DELETE, etc.)
- Request parameters
- Status codes
- Request and response schemas
Installation
npm install next-mcp-server
Or if you're using pnpm:
pnpm add next-mcp-server
Usage
Command Line
You can run the mcp server directly:
npm run build
node dist/index.js
Docker
docker build -t mcp/next -f Dockerfile .
docker run mcp/next -d
For cursor usage, define a mcp.json under ~/.cursor or [projectDir]/.cursor
{
"mcpServers": {
"next.js": {
"url": "http://localhost:4857/sse"
}
}
}
The url here could vary based on your .env settings within the project.
Output
The tool generates detailed information about 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
To run tests:
npm run test
To run the mcp server locally:
npm run build
node dist/index.js
To run it from node_modules after npm i:
node node_modules/next-mcp-server/dist/index.js
To run the playground:
pnpm --filter playground dev
How It Works
The tool:
1. Scans your Next.js app directory structure for route files
2. Analyzes each route file to extract HTTP methods, paths, parameters, etc.
3. Extracts documentation from comments
4. Returns a structured representation of all your API routes
Restrictions
1. Due to the nature of accessing filesystem directory by path, it will not work if hosted over network
2. Only supports Next.js App router projects
License
MIT
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
