AI导哈

Next.js路由分析工具

Next.js MCP Server是一个用于分析Next.js应用目录结构并提取API路由信息的工具，适用于开发者在本地开发环境中快速了解和管理API路由。

  • by vertile-ai
  • TypeScript
  • 混合部署
  • 99 星标
  • 更新于
在 GitHub 查看 vertile-ai/next-mcp-server

使用说明

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 build -t mcp/next -f Dockerfile .
docker run mcp/next -d

对于光标使用，定义 mcp.json 在...之下 ~/.cursor 或 [projectDir]/.cursor

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

发展

要运行测试，请执行以下操作：

npm run test

要在本地运行mcp服务器：

npm run build
node dist/index.js

在以下时间从node_modules运行它 npm i:

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

要运行操场：

pnpm --filter playground dev

运作原理

工具：

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

限制

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

许可证

麻省理工学院

相关 MCP