feat: rsdoctor mcp get auto port (#1072)

Co-authored-by: neverland <chenjiahan.jait@bytedance.com>

Author: easy1090

examples/rsbuild-minimal/rsbuild.config.ts

@@ -10,7 +10,6 @@ export default defineConfig({
       chain.plugin('Rsdoctor').use(RsdoctorRspackPlugin, [
         {
           disableClientServer: !process.env.ENABLE_CLIENT_SERVER,
-          features: ['bundle', 'plugins', 'loader', 'resolver'],
           output: {
             reportCodeType: {
               noAssetsAndModuleSource: true,

packages/ai/src/server/server.ts

@@ -16,6 +16,7 @@ import {
   getSimilarPackages,
   getLoaderTimeForAllFiles,
   getLoaderTimes,
+  getPort,
 } from './tools.js';
 import { registerStaticResources } from './resource.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
@@ -274,6 +275,20 @@ server.tool(
   },
 );
 
+server.tool(Tools.getPort, 'Get the port of the MCP server', {}, async () => {
+  const res = await getPort();
+  return {
+    content: [
+      {
+        name: Tools.getPort,
+        description: 'Get the port of the MCP server',
+        type: 'text',
+        text: res,
+      },
+    ],
+  };
+});
+
 registerStaticResources(server);
 
 export async function runServer() {

packages/ai/src/server/socket.ts

@@ -1,5 +1,7 @@
 import { Socket, io } from 'socket.io-client';
 import { logger } from '@rsdoctor/utils/logger';
+import { GlobalConfig } from '@rsdoctor/utils/common';
+import fs from 'node:fs';
 
 const map: Record<string, Socket> = {};
 
@@ -19,10 +21,21 @@ export const createSocket = (url: string): Socket => {
 export function getPortFromArgs(): number {
   const args = process.argv.slice(2); // Skip the first two elements
   const portIndex = args.indexOf('--port');
+  const builderIndex = args.indexOf('--builder');
   if (portIndex !== -1 && args[portIndex + 1]) {
     return parseInt(args[portIndex + 1], 10);
   }
-  return 3000; // Default port if not specified
+  if (portIndex === -1) {
+    const port = getMcpPort(
+      builderIndex !== -1 ? args[builderIndex + 1] : undefined,
+    );
+    if (port) {
+      return port;
+    }
+  }
+
+  // If no port is specified, use the default port.
+  return 3000;
 }
 
 export const getWsUrl = async () => {
@@ -42,3 +55,22 @@ export const sendRequest = async (api: string, params = {}) => {
   });
   return res;
 };
+
+export const getMcpPort = (builder?: string) => {
+  const mcpPortFilePath = GlobalConfig.getMcpConfigPath();
+
+  if (!fs.existsSync(mcpPortFilePath)) {
+    return undefined;
+  }
+
+  const mcpJson = JSON.parse(fs.readFileSync(mcpPortFilePath, 'utf8'));
+
+  if (builder) {
+    const builderPort = mcpJson.portList[builder];
+    if (builderPort) {
+      return builderPort;
+    }
+  }
+
+  return mcpJson.port;
+};

packages/ai/src/server/tools.ts

@@ -1,5 +1,5 @@
 import { SDK } from '@rsdoctor/types';
-import { sendRequest } from './socket.js';
+import { getWsUrl, sendRequest } from './socket.js';
 import { toolDescriptions } from '@/prompt/bundle.js';
 
 export enum Tools {
@@ -19,6 +19,7 @@ export enum Tools {
   GetMediaAssetPrompt = 'get_media_asset_prompt',
   getLoaderTimeForAllFiles = 'get_loader_time_all_files',
   getLoaderTimes = 'get_loader_times',
+  getPort = 'get_port',
 }
 
 // Define the type for the response of getAllChunks
@@ -185,16 +186,22 @@ export const getPackageInfo = async (): Promise<
 };
 
 export const getPackageDependency = async () => {
-  return await sendRequest(SDK.ServerAPI.API.GetPackageDependency, {});
+  const res = (await sendRequest(
+    SDK.ServerAPI.API.GetPackageDependency,
+    {},
+  )) as SDK.ServerAPI.InferResponseType<SDK.ServerAPI.API.GetPackageDependency>;
+  if (res.length > 300) {
+    return res.slice(0, 300);
+  }
+  return res;
 };
 
 export const getRuleInfo = async () => {
   return await sendRequest(SDK.ServerAPI.API.GetOverlayAlerts, {});
 };
 
 export const getDuplicatePackages = async () => {
-  const ruleInfo =
-    (await getRuleInfo()) as SDK.ServerAPI.InferResponseType<SDK.ServerAPI.API.GetOverlayAlerts>;
+  const ruleInfo = await sendRequest(SDK.ServerAPI.API.GetOverlayAlerts, {});
 
   if (!ruleInfo) {
     return {
@@ -330,3 +337,7 @@ export const getLoaderTimeForAllFiles = async (): Promise<
 export const getLoaderTimes = async () => {
   return await sendRequest(SDK.ServerAPI.API.GetDirectoriesLoaders, {});
 };
+
+export const getPort = async () => {
+  return getWsUrl();
+};

packages/sdk/src/sdk/server/index.ts

@@ -1,15 +1,15 @@
 import { Common, SDK, Thirdparty, Client } from '@rsdoctor/types';
 import { Server } from '@rsdoctor/utils/build';
 import serve from 'sirv';
-import { Bundle } from '@rsdoctor/utils/common';
+import { Bundle, GlobalConfig } from '@rsdoctor/utils/common';
 import assert from 'assert';
 import bodyParser from 'body-parser';
 import cors from 'cors';
 import { PassThrough } from 'stream';
 import { Socket } from './socket';
 import { Router } from './router';
 import * as APIs from './apis';
-import { chalk, logger } from '@rsdoctor/utils/logger';
+import { chalk, debug, logger } from '@rsdoctor/utils/logger';
 import { openBrowser } from '@/sdk/utils/openBrowser';
 import path from 'path';
 import { getLocalIpAddress } from './utils';
@@ -88,6 +88,13 @@ export class RsdoctorServer implements SDK.RsdoctorServerInstance {
     });
     await this._socket.bootstrap();
 
+    GlobalConfig.writeMcpPort(this.port, this.sdk.name);
+
+    debug(
+      () =>
+        `Successfully wrote mcp.json for ${chalk.cyan(this.sdk.name)} builder`,
+    );
+
     this.disposed = false;
 
     this.app.use(cors());
@@ -223,9 +230,8 @@ export class RsdoctorServer implements SDK.RsdoctorServerInstance {
     const localhostUrl = `http://localhost:${this.port}${relativeUrl}`;
     await openBrowser(localhostUrl, !needEncodeURI);
     if (this._printServerUrl) {
-      logger.info(`Rsdoctor analyze server running on: ${chalk.cyan(url)}`);
       logger.info(
-        `Rsdoctor analyze server running on: ${chalk.cyan(localhostUrl)}`,
+        `${chalk.green(`${this.sdk.name} compiler's`)} analyzer running on: ${chalk.cyan(url)}`,
       );
     }
   }

packages/utils/src/common/data/index.ts

@@ -455,8 +455,20 @@ export class APIDataLoader {
         return this.loader.loadData('moduleGraph').then((moduleGraph) => {
           const { moduleId } =
             body as SDK.ServerAPI.InferRequestBodyType<SDK.ServerAPI.API.GetModuleIssuerPath>;
-          return (moduleGraph?.modules.find((m) => String(m.id) === moduleId)
-            ?.issuerPath || []) as R;
+          const modules = moduleGraph?.modules || [];
+          const issuerPath =
+            modules.find((m) => String(m.id) === moduleId)?.issuerPath || [];
+          if (
+            Array.isArray(issuerPath) &&
+            issuerPath.length > 0 &&
+            typeof issuerPath[0] === 'number'
+          ) {
+            return issuerPath
+              .map((id) => modules.find((m) => m.id === id)?.path)
+              .filter(Boolean) as R;
+          }
+
+          return issuerPath as R;
         });
 
       case SDK.ServerAPI.API.GetPackageInfo:
@@ -488,6 +500,9 @@ export class APIDataLoader {
           const chunkInfo = chunks.find(
             (c) => c.id === chunkId,
           ) as SDK.ServerAPI.ExtendedChunkData;
+          if (!chunkInfo) {
+            return null as R;
+          }
           const chunkModules = modules
             .filter((m) => chunkInfo.modules.includes(m.id))
             .map((module) => {

packages/utils/src/common/global-config.ts

@@ -0,0 +1,55 @@
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+
+/**
+ * @description Writes the builder port information to mcp.json.
+ *
+ * The mcp.json file uses the following format:
+ * {
+ *   portList: {
+ *     builder1: portNumber,
+ *     builder2: portNumber,
+ *   },
+ *   port: portNumber // The port of the last builder is used by default
+ * }
+ *
+ * @param {number} port - The port number to write.
+ * @param {string} [builderName] - The name of the builder.
+ */
+export function writeMcpPort(port: number, builderName?: string) {
+  const homeDir = os.homedir();
+  const rsdoctorDir = path.join(homeDir, '.cache/rsdoctor');
+  const mcpPortFilePath = path.join(rsdoctorDir, 'mcp.json');
+
+  if (!fs.existsSync(rsdoctorDir)) {
+    fs.mkdirSync(rsdoctorDir, { recursive: true });
+  }
+
+  let mcpJson: { portList: Record<string, number>; port: number } = {
+    portList: {},
+    port: 0,
+  };
+  if (fs.existsSync(mcpPortFilePath)) {
+    mcpJson = JSON.parse(fs.readFileSync(mcpPortFilePath, 'utf8'));
+  }
+
+  if (!mcpJson.portList) mcpJson.portList = {};
+  mcpJson.portList[builderName || 'builder'] = port;
+
+  // Use the latest generated port.
+  mcpJson.port = port;
+
+  fs.writeFileSync(mcpPortFilePath, JSON.stringify(mcpJson, null, 2), 'utf8');
+}
+
+/**
+ * @description Gets the path to the mcp.json file.
+ * @returns {string} The path to the mcp.json file.
+ */
+export function getMcpConfigPath() {
+  const homeDir = os.homedir();
+  const rsdoctorDir = path.join(homeDir, '.cache/rsdoctor');
+  const mcpPortFilePath = path.join(rsdoctorDir, 'mcp.json');
+  return mcpPortFilePath;
+}

packages/utils/src/common/index.ts

@@ -14,3 +14,4 @@ export * as Alerts from './alerts';
 export * as Rspack from './rspack';
 export * as Package from './package';
 export * as Lodash from './lodash';
+export * as GlobalConfig from './global-config';