Next.js MCP Server

Next.js MCP Server

site icon
2025.03.27 85
TypeScriptAPI 路由分析Next.js 工具开发效率
Next.js MCP Server 是一个专为 Next.js 应用设计的 API 路由分析工具。它能够扫描 Next.js 应用目录结构,提取所有 API 路由的详细信息,包括路径、HTTP 方法、请求参数、状态码以及请求和响应模式。该工具旨在帮助开发者更好地理解和维护他们的 API 路由结构。
View on GitHub

Overview

基本能力

产品定位

Next.js MCP Server 是一个 API 路由分析工具,专为 Next.js 应用设计,帮助开发者提取和分析 API 路由的详细信息。

核心功能

  • 路由分析:扫描 Next.js 应用目录结构,提取 API 路由的详细信息。
  • API 路径
  • HTTP 方法(GET、POST、PUT、DELETE 等)
  • 请求参数
  • 状态码
  • 请求和响应模式

适用场景

  • 开发者需要快速了解 Next.js 应用中的 API 路由结构。
  • 团队协作时,需要统一理解和维护 API 路由。
  • 自动化生成 API 文档或进行 API 测试。

工具列表

  • get-routers-info:扫描并提取 Next.js 应用中的 API 路由信息。

常见问题解答

  1. 是否支持网络托管?
  2. 不支持,因为工具需要直接访问文件系统目录。
  3. 支持哪些 Next.js 路由?
  4. 仅支持 Next.js App 路由项目。

使用教程

使用依赖

确保已安装 Node.js 和 npm 或 pnpm。

安装教程

使用 npm 安装:

npm install next-mcp-server

或使用 pnpm 安装:

pnpm add next-mcp-server

调试方式

运行工具:

npm run build
node dist/index.js

或从 node_modules 运行:

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

运行测试:

npm run test

运行 playground:

pnpm --filter playground dev

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。