Next.js MCP Server
帮助LLM更好地理解您的Next应用程序。
简介
Next.js MCP 服务器是一个工具,可以帮助LLM更好地理解您的Next.js应用程序,提供路由分析和API文档生成功能。
安装
# 使用npm
npm install next-mcp-server
# 或使用pnpm
pnpm add next-mcp-server
快速启动
1. 启动服务器
# 构建并运行
npm run build
node dist/index.js
2. 使用Docker
docker build -t mcp/next -f Dockerfile . docker run mcp/next -d
3. 与Cursor集成
在~/.cursor
或[projectDir]/.cursor
创建mcp.json
文件:
{
"mcpServers": {
"next.js": {
"url": "http://localhost:4857/sse"
}
}
}
核心功能
get-routers-info
功能会扫描Next.js应用程序目录结构,提取所有API路由的信息:
- API路径
- HTTP方法(GET、POST等)
- 请求参数
- 状态码
- 请求和响应模式
输出示例
[
{
"filePath": "/path/to/your/app/api/test/route.ts",
"apiPath": "/api/test",
"handlers": [
{
"method": "GET",
"description": "获取测试数据",
"statusCodes": [200]
},
{
"method": "POST",
"description": "创建测试数据",
"requestBodySchema": "{ name: string }",
"statusCodes": [201, 400]
}
]
}
]
限制说明
- 仅支持Next.js App Router项目
- 在网络托管环境下无法工作(需要访问文件系统)
开发
# 运行测试
node run-router-test.js
# 运行playground
pnpm --filter playground dev
许可证
MIT