feat: add new tools for routes, appdata and changelog (#7)

Author: Wu-kung

README.md

@@ -28,14 +28,32 @@ MCP collection for the [umi](https://github.com/umijs/umi) framework.
 - `umi-setup`, Setup the umi project and generate the tmp files in the `.umi` directory.
 - `umi-deadcode`, Find the dead code of the umi project.
 - `umi-version`, Show the version of the umi project.
-- [ ] `umi-route-list`, List all routes of the umi project. (Based on the appData under `.umi` directory)
-- [ ] `umi-appdata-list`, List detailed app data of the umi project. (Based on the appData under `.umi` directory)
+- `umi-route-list`, List all routes of the umi project. (Based on the appData under `.umi` directory)
+- `umi-appdata-list`, List detailed app data of the umi project. (Based on the appData under `.umi` directory)
+- `umi-changelog`, Show the changelog of the umi and @umijs/max.
 
 ## Usage
 
 ```bash
 $ npx -y umi-mcp <root>
 ```
+### Usage with Cursor
+add the following to your `<root>/.cursor/mcp.json`:
+#### NPX
+```json
+{
+  "mcpServers": {
+    "umi-mcp": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "umi-mcp",
+        "<root>"
+      ]
+    }
+  }
+}
+```
 
 ## CONTRIBUTING
 

src/index.ts

@@ -1,9 +1,12 @@
+import { umiAppdataList } from './tools/umi-appdata-list';
 import { umiBuild } from './tools/umi-build';
+import { umiChangelog } from './tools/umi-changelog';
 import { umiConfig } from './tools/umi-config';
 import { umiGenerate } from './tools/umi-generate';
 import { umiHelp } from './tools/umi-help';
 import { umiLint } from './tools/umi-lint';
 import { umiPlugin } from './tools/umi-plugin';
+import { umiRouteList } from './tools/umi-route-list';
 import { umiSetup } from './tools/umi-setup';
 import { umiVersion } from './tools/umi-version';
 import { ToolContext } from './types';
@@ -19,4 +22,7 @@ export function registerTools(toolContext: ToolContext) {
   umiPlugin(toolContext);
   umiGenerate(toolContext);
   umiLint(toolContext);
+  umiRouteList(toolContext);
+  umiAppdataList(toolContext);
+  umiChangelog(toolContext);
 }

src/path.ts

@@ -0,0 +1,24 @@
+import { existsSync, statSync } from 'fs';
+import { join } from 'path';
+
+export function winPath(path: string) {
+  const isExtendedLengthPath = /^\\\\\?\\/.test(path);
+  if (isExtendedLengthPath) {
+    return path;
+  }
+  return path.replace(/\\/g, '/');
+}
+
+function winJoin(...args: string[]) {
+  return winPath(join(...args));
+}
+
+export function getPaths(cwd: string, frameworkName: string) {
+  const src = winJoin(cwd, 'src');
+  const absSrcPath = existsSync(src) && statSync(src).isDirectory() ? src : cwd;
+  const absTmpPath = winJoin(absSrcPath, `.${frameworkName}`);
+  return {
+    absSrcPath,
+    absTmpPath,
+  };
+}

src/tools/umi-appdata-list.ts

@@ -0,0 +1,38 @@
+import assert from 'assert';
+import { execSync } from 'child_process';
+import { existsSync, readFileSync } from 'fs';
+import { z } from 'zod';
+import { parse } from '../parse';
+import { getPaths } from '../path';
+import { ToolContext } from '../types';
+
+export const umiAppdataList = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
+  server.addTool({
+    name: `${frameworkName}-appdata-list`,
+    description: `List the appData of the ${frameworkName} project.`,
+    parameters: z.object({}),
+    execute: async () => {
+      const { absTmpPath } = getPaths(root, frameworkName);
+
+      if (!existsSync(absTmpPath)) {
+        const { binPath } = parse(root);
+        execSync(`${binPath} setup`, { cwd: root });
+      }
+
+      const appDataPath = `${absTmpPath}/appData.json`;
+      assert(
+        existsSync(appDataPath),
+        `${appDataPath} is not exist, please upgrade to the latest version of ${frameworkName}`,
+      );
+      const appDataJson = JSON.parse(readFileSync(appDataPath, 'utf-8'));
+      return {
+        type: 'text',
+        text: JSON.stringify(appDataJson, null, 2),
+      };
+    },
+  });
+};

src/tools/umi-build.ts

@@ -10,7 +10,7 @@ export const umiBuild = async ({
 }: ToolContext) => {
   const BuildParams = z.object({
     ANALYZE: z
-      .union([z.literal(1), z.literal(0)])
+      .literal(1)
       .optional()
       .describe('Analyze the bundle composition, disabled by default.'),
     ANALYZE_PORT: z.number().optional().describe('Custom port'),
@@ -37,16 +37,25 @@ export const umiBuild = async ({
     description: `Build the ${frameworkName} project.`,
     parameters: BuildParams,
     execute: async (params) => {
-      const { binPath } = parse(root);
-      const env = { ...process.env };
-      Object.entries(params).forEach(([key, value]) => {
-        if (value !== undefined) {
-          env[key] = typeof value === 'number' ? value.toString() : value;
+      try {
+        const { binPath } = parse(root);
+        const env = { ...process.env };
+        for (const [key, value] of Object.entries(params)) {
+          if (value !== undefined && (value === 1 || value === 'none')) {
+            env[key] = typeof value === 'number' ? value.toString() : value;
+          }
         }
-      });
-
-      const result = execSync(`${binPath} build`, { env, cwd: root });
-      return result.toString();
+        const result = execSync(`${binPath} build`, {
+          env,
+          cwd: root,
+          timeout: 5 * 60000,
+        });
+        return result.toString();
+      } catch (error) {
+        throw new Error(
+          `Build failed. Please check the error message above.\n${error}`,
+        );
+      }
     },
   });
 };

src/tools/umi-changelog.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+import { ToolContext } from '../types';
+
+export const umiChangelog = async ({ server }: ToolContext) => {
+  server.addTool({
+    name: 'umi-changelog',
+    description: 'Show the changelog of the  umi and @umijs/max.',
+    parameters: z.object({
+      version: z
+        .string()
+        .describe('Get the changelog for the current version,eg: 4.4.6'),
+    }),
+    execute: async ({ version }) => {
+      const result = await fetch(
+        `https://api.github.com/repos/umijs/umi/releases/tags/v${version}`,
+      );
+      if (!result.ok) {
+        throw new Error(`Failed to fetch changelog: ${result.statusText}`);
+      }
+      const { body } = await result.json();
+      return body;
+    },
+  });
+};

src/tools/umi-route-list.ts

@@ -0,0 +1,39 @@
+import assert from 'assert';
+import { execSync } from 'child_process';
+import { existsSync, readFileSync } from 'fs';
+import { z } from 'zod';
+import { parse } from '../parse';
+import { getPaths } from '../path';
+import { ToolContext } from '../types';
+
+export const umiRouteList = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
+  server.addTool({
+    name: `${frameworkName}-route-list`,
+    description: `List the routes of the ${frameworkName} project.`,
+    parameters: z.object({}),
+    execute: async () => {
+      const { absTmpPath } = getPaths(root, frameworkName);
+
+      if (!existsSync(absTmpPath)) {
+        const { binPath } = parse(root);
+        execSync(`${binPath} setup`, { cwd: root });
+      }
+
+      const appDataPath = `${absTmpPath}/appData.json`;
+      assert(
+        existsSync(appDataPath),
+        `${appDataPath} is not exist, please upgrade to the latest version of ${frameworkName}`,
+      );
+      const appDataJson = JSON.parse(readFileSync(appDataPath, 'utf-8'));
+      const routes = appDataJson.defaultConfig?.routes || [];
+      return {
+        type: 'text',
+        text: JSON.stringify(routes, null, 2),
+      };
+    },
+  });
+};