|
| 1 | +/** |
| 2 | + * MCP tool for getting all routes that become entry points in a Next.js application. |
| 3 | + * |
| 4 | + * This tool discovers routes by scanning the filesystem directly. It finds all route |
| 5 | + * files in the app/ and pages/ directories and converts them to route paths. |
| 6 | + * |
| 7 | + * Returns routes grouped by router type: |
| 8 | + * - appRouter: App Router pages and route handlers |
| 9 | + * - pagesRouter: Pages Router pages and API routes |
| 10 | + * |
| 11 | + * Dynamic route segments appear as [id], [slug], or [...slug] patterns. This tool |
| 12 | + * does NOT expand getStaticParams - it only shows the route patterns as defined in |
| 13 | + * the filesystem. |
| 14 | + */ |
| 15 | +import type { McpServer } from 'next/dist/compiled/@modelcontextprotocol/sdk/server/mcp' |
| 16 | +import { mcpTelemetryTracker } from '../mcp-telemetry-tracker' |
| 17 | +import { |
| 18 | + collectAppFiles, |
| 19 | + collectPagesFiles, |
| 20 | + processAppRoutes, |
| 21 | + processPageRoutes, |
| 22 | + createPagesMapping, |
| 23 | +} from '../../../build/entries' |
| 24 | +import { createValidFileMatcher } from '../../lib/find-page-file' |
| 25 | +import { PAGE_TYPES } from '../../../lib/page-types' |
| 26 | +import type { NextConfigComplete } from '../../../server/config-shared' |
| 27 | +import z from 'next/dist/compiled/zod' |
| 28 | + |
| 29 | +interface RouteInfo { |
| 30 | + route: string |
| 31 | + type: 'app' | 'page' | 'api' |
| 32 | +} |
| 33 | + |
| 34 | +export function registerGetRoutesTool( |
| 35 | + server: McpServer, |
| 36 | + options: { |
| 37 | + projectPath: string |
| 38 | + nextConfig: NextConfigComplete |
| 39 | + pagesDir: string | undefined |
| 40 | + appDir: string | undefined |
| 41 | + } |
| 42 | +) { |
| 43 | + server.registerTool( |
| 44 | + 'get_routes', |
| 45 | + { |
| 46 | + description: |
| 47 | + 'Get all routes that will become entry points in the Next.js application by scanning the filesystem. Returns routes grouped by router type (appRouter, pagesRouter). Dynamic segments appear as [param] or [...slug] patterns. API routes are included in their respective routers (e.g., /api/* routes from pages/ are in pagesRouter). Optional parameter: routerType ("app" | "pages") - filter by specific router type, omit to get all routes.', |
| 48 | + inputSchema: { |
| 49 | + routerType: z.union([z.literal('app'), z.literal('pages')]).optional(), |
| 50 | + }, |
| 51 | + }, |
| 52 | + async (request) => { |
| 53 | + // Track telemetry |
| 54 | + mcpTelemetryTracker.recordToolCall('mcp/get_routes') |
| 55 | + |
| 56 | + try { |
| 57 | + const routerType = |
| 58 | + request.routerType === 'app' || request.routerType === 'pages' |
| 59 | + ? request.routerType |
| 60 | + : undefined |
| 61 | + |
| 62 | + const routes: RouteInfo[] = [] |
| 63 | + |
| 64 | + const { projectPath, nextConfig, pagesDir, appDir } = options |
| 65 | + |
| 66 | + // Check if we have any directories to scan |
| 67 | + if (!pagesDir && !appDir) { |
| 68 | + return { |
| 69 | + content: [ |
| 70 | + { |
| 71 | + type: 'text', |
| 72 | + text: 'No pages or app directory found in the project.', |
| 73 | + }, |
| 74 | + ], |
| 75 | + } |
| 76 | + } |
| 77 | + |
| 78 | + const isSrcDir = |
| 79 | + (pagesDir && pagesDir.includes('/src/')) || |
| 80 | + (appDir && appDir.includes('/src/')) |
| 81 | + |
| 82 | + // Create valid file matcher for filtering |
| 83 | + const validFileMatcher = createValidFileMatcher( |
| 84 | + nextConfig.pageExtensions, |
| 85 | + appDir |
| 86 | + ) |
| 87 | + |
| 88 | + // Collect and process App Router routes if requested |
| 89 | + if (appDir && (!routerType || routerType === 'app')) { |
| 90 | + try { |
| 91 | + const { appPaths } = await collectAppFiles(appDir, validFileMatcher) |
| 92 | + |
| 93 | + if (appPaths.length > 0) { |
| 94 | + const mappedAppPages = await createPagesMapping({ |
| 95 | + pagePaths: appPaths, |
| 96 | + isDev: true, |
| 97 | + pagesType: PAGE_TYPES.APP, |
| 98 | + pageExtensions: nextConfig.pageExtensions, |
| 99 | + pagesDir, |
| 100 | + appDir, |
| 101 | + appDirOnly: pagesDir ? false : true, |
| 102 | + }) |
| 103 | + |
| 104 | + const { appRoutes, appRouteHandlers } = processAppRoutes( |
| 105 | + mappedAppPages, |
| 106 | + validFileMatcher, |
| 107 | + projectPath, |
| 108 | + isSrcDir || false |
| 109 | + ) |
| 110 | + |
| 111 | + // Add app page routes |
| 112 | + for (const { route } of appRoutes) { |
| 113 | + routes.push({ |
| 114 | + route, |
| 115 | + type: 'app', |
| 116 | + }) |
| 117 | + } |
| 118 | + |
| 119 | + // Add app route handlers |
| 120 | + for (const { route } of appRouteHandlers) { |
| 121 | + routes.push({ |
| 122 | + route, |
| 123 | + type: 'app', |
| 124 | + }) |
| 125 | + } |
| 126 | + } |
| 127 | + } catch (error) { |
| 128 | + // Error collecting app routes - continue anyway |
| 129 | + } |
| 130 | + } |
| 131 | + |
| 132 | + // Collect and process Pages Router routes if requested |
| 133 | + if (pagesDir && (!routerType || routerType === 'pages')) { |
| 134 | + try { |
| 135 | + const pagePaths = await collectPagesFiles( |
| 136 | + pagesDir, |
| 137 | + validFileMatcher |
| 138 | + ) |
| 139 | + |
| 140 | + if (pagePaths.length > 0) { |
| 141 | + const mappedPages = await createPagesMapping({ |
| 142 | + pagePaths, |
| 143 | + isDev: true, |
| 144 | + pagesType: PAGE_TYPES.PAGES, |
| 145 | + pageExtensions: nextConfig.pageExtensions, |
| 146 | + pagesDir, |
| 147 | + appDir, |
| 148 | + appDirOnly: false, |
| 149 | + }) |
| 150 | + |
| 151 | + const { pageRoutes, pageApiRoutes } = processPageRoutes( |
| 152 | + mappedPages, |
| 153 | + projectPath, |
| 154 | + isSrcDir || false |
| 155 | + ) |
| 156 | + |
| 157 | + // Add page routes |
| 158 | + for (const { route } of pageRoutes) { |
| 159 | + routes.push({ |
| 160 | + route, |
| 161 | + type: 'page', |
| 162 | + }) |
| 163 | + } |
| 164 | + |
| 165 | + // Add API routes (always included as part of pages router) |
| 166 | + for (const { route } of pageApiRoutes) { |
| 167 | + routes.push({ |
| 168 | + route, |
| 169 | + type: 'api', |
| 170 | + }) |
| 171 | + } |
| 172 | + } |
| 173 | + } catch (error) { |
| 174 | + // Error collecting pages routes - continue anyway |
| 175 | + } |
| 176 | + } |
| 177 | + |
| 178 | + if (routes.length === 0) { |
| 179 | + return { |
| 180 | + content: [ |
| 181 | + { |
| 182 | + type: 'text', |
| 183 | + text: 'No routes found in the project.', |
| 184 | + }, |
| 185 | + ], |
| 186 | + } |
| 187 | + } |
| 188 | + |
| 189 | + // Group routes by router type |
| 190 | + const appRoutes = routes |
| 191 | + .filter((r) => r.type === 'app') |
| 192 | + .map((r) => r.route) |
| 193 | + .sort() |
| 194 | + const pageRoutes = routes |
| 195 | + .filter((r) => r.type === 'page' || r.type === 'api') |
| 196 | + .map((r) => r.route) |
| 197 | + .sort() |
| 198 | + |
| 199 | + // Format the output with grouped routes |
| 200 | + const output = { |
| 201 | + appRouter: appRoutes.length > 0 ? appRoutes : undefined, |
| 202 | + pagesRouter: pageRoutes.length > 0 ? pageRoutes : undefined, |
| 203 | + } |
| 204 | + |
| 205 | + return { |
| 206 | + content: [ |
| 207 | + { |
| 208 | + type: 'text', |
| 209 | + text: JSON.stringify(output, null, 2), |
| 210 | + }, |
| 211 | + ], |
| 212 | + } |
| 213 | + } catch (error) { |
| 214 | + return { |
| 215 | + content: [ |
| 216 | + { |
| 217 | + type: 'text', |
| 218 | + text: `Error: ${error instanceof Error ? error.message : String(error)}`, |
| 219 | + }, |
| 220 | + ], |
| 221 | + } |
| 222 | + } |
| 223 | + } |
| 224 | + ) |
| 225 | +} |
0 commit comments