Next.js API Scanner

🚀 Next.js MCP 服務器

Next.js MCP 服務器是一款專為 Next.js 應用設計的工具，它能夠掃描應用目錄結構，提取 API 路由信息，為開發者提供詳細的路由分析，助力高效開發。

🚀 快速開始

本工具可直接運行 mcp 服務器，也能通過 Docker 部署，還能結合 cursor 使用。

命令行

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 等）
• 請求參數
• 狀態碼
• 請求和響應模式

📦 安裝指南

你可以使用 npm 或 pnpm 進行安裝：

npm install next-mcp-server

或者如果你使用 pnpm：

pnpm add next-mcp-server

💻 使用示例

基礎用法

該工具生成了每個路由的詳細信息：

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

從 node_modules 運行（在 npm i 後）：

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

運行 playground：

pnpm --filter playground dev

工作原理

該工具：

1. 掃描你的 Next.js 應用目錄結構以查找路由文件
2. 分析每個路由文件以提取 HTTP 方法、路徑、參數等信息
3. 從註釋中提取文檔信息
4. 返回所有 API 路由的結構化表示

限制

1. 由於通過路徑訪問文件系統的性質，如果 hosted 在網絡上將無法工作
2. 只支持 Next.js App 路由項目

📄 許可證

本項目採用 MIT 許可證。

演示