Next MCP Server

🚀 Next.js MCP 服務器

Next.js MCP 服務器是一款強大的路由器分析工具，它能夠掃描 Next.js 應用目錄結構，提取所有 API 路由的詳細信息，助力開發者高效管理和維護項目。

🚀 快速開始

安裝

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 設置。

✨ 主要特性

• get-routers-info：該路由器分析工具會掃描你的 Next.js 應用目錄結構，並提取所有 API 路由的信息，包括 API 路徑、HTTP 方法（GET、POST、PUT、DELETE 等）、請求參數、狀態碼、請求和響應模式。

💻 使用示例

基礎用法

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

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

🔧 技術細節

該工具的工作原理如下：

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

⚠️ 限制說明

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

📄 許可證

MIT