🚀 Next.js MCP 服务器
Next.js MCP 服务器是一款强大的路由器分析工具，它能够扫描 Next.js 应用目录结构，提取所有 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 等）、请求参数、状态码、请求和响应模式。
💻 使用示例
基础用法
该工具会生成每个路由的详细信息：
[
{
"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]
}
]
}
]
🔧 技术细节
该工具的工作原理如下：
- 扫描你的 Next.js 应用目录结构以查找路由文件。
- 分析每个路由文件以提取 HTTP 方法、路径、参数等信息。
- 从注释中提取文档信息。
- 返回所有 API 路由的结构化表示。
⚠️ 限制说明
- 由于通过路径访问文件系统的性质，如果 hosted 在网络上将无法使用。
- 只支持 Next.js App 路由项目。
📄 许可证
MIT