内容
Next.js 路由分析服务器
## 演示

## 功能
- 获取路由信息
路由分析器扫描您的 Next.js 应用目录结构,并提取所有 API 路由的信息,包括:
- API 路径
- HTTP 方法(GET、POST、PUT、DELETE 等)
- 请求参数
- 状态码
- 请求和响应模式
## 安装
```bash
npm install next-mcp-server
```
或者,如果您使用 pnpm:
```bash
pnpm add next-mcp-server
```
## 使用
### 命令行
您可以直接运行 MCP 服务器:
```bash
npm run build
node dist/index.js
```
### Docker
```bash
docker build -t mcp/next -f Dockerfile .
docker run mcp/next -d
```
对于光标使用,在 `~/.cursor` 或 `[projectDir]/.cursor` 下定义一个 `mcp.json`
```
{
"mcpServers": {
"next.js": {
"url": "http://localhost:4857/sse"
}
}
}
```
这里的 `url` 可以根据项目中的 `.env` 设置而有所不同。
## 输出
该工具为每个路由生成详细信息:
```javascript
[
{
"filePath": "/path/to/your/app/api/test/route.ts",
"implementationPath": "/path/to/your/app/api/test/route.ts",
"apiPath": "/api/test",
"handlers": [
{
"method": "GET",
": "/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": [],
BodySchema": "{ name: string }",
"statusCodes": [201, 400]
}
]
}
]
```
## 开发
运行测试:bash
npm run```
在本地运行 MCP 服务器:
```bash
npm run build
node dist/index.js
```
在 `npm i` 后从 `node_modules` 运行:
```bash
node node_modules/next-mcp-server/dist/index.js
```
运行 playground:
```bash
pnpm --filter playground dev
```
## 工作原理
该工具:
1. 扫描 Next.js 应用目录结构中的路由文件
2. 分析每个路由文件以提取 HTTP 方法、路径、参数等
3.中提取文档
4. 返回所有 API 路由的结构化表示
## 限制
1. 由于通过路径访问文件系统目录的性质,它在通过网络托管时将无法工作
2. 仅支持 Next.js 应用路由器项目
## 许可证
MIT