Next.js MCP 服务器

演示

功能

• get-routers-info

  路由分析器扫描您的 Next.js 应用程序目录结构，并提取有关所有 API 路由的信息，包括：

  • API 路径
  • HTTP 方法（GET、POST、PUT、DELETE 等）
  • 请求参数
  • 状态码
  • 请求和响应模式

安装

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 设置而有所不同。

输出

该工具生成有关每个路由的详细信息：

[
  {
    "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]
      }
    ]
  }
]

开发

要运行测试：

npm run test

要在本地运行 mcp 服务器：

npm run build
node dist/index.js

要在 npm i 后从 node_modules 运行它：

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

要运行 playground：

pnpm --filter playground dev

工作原理

该工具：

1. 扫描您的 Next.js 应用程序目录结构以查找路由文件
2. 分析每个路由文件以提取 HTTP 方法、路径、参数等。
3. 从注释中提取文档
4. 返回所有 API 路由的结构化表示

限制

1. 由于通过路径访问文件系统目录的性质，如果托管在网络上，它将无法工作
2. 仅支持 Next.js App router 项目

许可证

MIT