feat: enhance tools to include framework name in descriptions and update ToolContext type

sorrycc · sorrycc · commit 5013944e2334 · 2025-04-09T16:18:24.000+08:00
diff --git a/src/tools/umi-build.ts b/src/tools/umi-build.ts
@@ -3,7 +3,11 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiBuild = async ({ server, root }: ToolContext) => {
+export const umiBuild = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   const BuildParams = z.object({
     ANALYZE: z
       .union([z.literal(1), z.literal(0)])
@@ -30,7 +34,7 @@ export const umiBuild = async ({ server, root }: ToolContext) => {
 
   server.addTool({
     name: 'umi-build',
-    description: 'Build the umi project.',
+    description: `Build the ${frameworkName} project.`,
     parameters: BuildParams,
     execute: async (params) => {
       const { binPath } = parse(root);
diff --git a/src/tools/umi-config.ts b/src/tools/umi-config.ts
@@ -3,10 +3,14 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiConfig = async ({ server, root }: ToolContext) => {
+export const umiConfig = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   server.addTool({
     name: 'umi-config-list',
-    description: 'List all available umi config',
+    description: `List all available ${frameworkName} config`,
     parameters: z.object({}),
     execute: async () => {
       const { binPath } = parse(root);
@@ -17,7 +21,7 @@ export const umiConfig = async ({ server, root }: ToolContext) => {
 
   server.addTool({
     name: 'umi-config-get',
-    description: 'Get the value of a config of the umi project',
+    description: `Get the value of a config of the ${frameworkName} project`,
     parameters: z.object({
       key: z.string(),
     }),
@@ -30,7 +34,7 @@ export const umiConfig = async ({ server, root }: ToolContext) => {
 
   server.addTool({
     name: 'umi-config-set',
-    description: 'Set the value of a config of the umi project',
+    description: `Set the value of a config of the ${frameworkName} project`,
     parameters: z.object({
       key: z.string(),
       value: z.string(),
@@ -46,7 +50,7 @@ export const umiConfig = async ({ server, root }: ToolContext) => {
 
   server.addTool({
     name: 'umi-config-remove',
-    description: 'Remove a config of the umi project',
+    description: `Remove a config of the ${frameworkName} project`,
     parameters: z.object({
       key: z.string(),
     }),
diff --git a/src/tools/umi-deadcode.ts b/src/tools/umi-deadcode.ts
@@ -3,10 +3,14 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiDeadcode = async ({ server, root }: ToolContext) => {
+export const umiDeadcode = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   server.addTool({
     name: 'umi-deadcode',
-    description: 'Find the dead code of the umi project',
+    description: `Find the dead code of the ${frameworkName} project`,
     parameters: z.object({}),
     execute: async () => {
       const { binPath } = parse(root);
diff --git a/src/tools/umi-generate.ts b/src/tools/umi-generate.ts
@@ -32,13 +32,17 @@ const executeGenerator = (command: string, cwd: string): string => {
   return result.toString();
 };
 
-export const umiGenerate = async ({ server, root }: ToolContext) => {
+export const umiGenerate = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   const { binPath } = parse(root);
 
   // 页面生成器
   server.addTool({
     name: 'umi-generate-page',
-    description: 'Generate a page for the umi project',
+    description: `Generate a page for the ${frameworkName} project`,
     parameters: z.object({
       name: z.string().describe('Page name to generate'),
       dir: z
@@ -60,7 +64,7 @@ export const umiGenerate = async ({ server, root }: ToolContext) => {
   // 组件生成器
   server.addTool({
     name: 'umi-generate-component',
-    description: 'Generate a component for the umi project',
+    description: `Generate a component for the ${frameworkName} project`,
     parameters: z.object({
       name: z.string().describe('Component name to generate'),
     }),
@@ -77,7 +81,7 @@ export const umiGenerate = async ({ server, root }: ToolContext) => {
   // RouteAPI 生成器
   server.addTool({
     name: 'umi-generate-api',
-    description: 'Generate a route API for the umi project',
+    description: `Generate a route API for the ${frameworkName} project`,
     parameters: z.object({
       name: z.string().describe('API route name to generate'),
     }),
@@ -93,7 +97,7 @@ export const umiGenerate = async ({ server, root }: ToolContext) => {
   // Mock 生成器
   server.addTool({
     name: 'umi-generate-mock',
-    description: 'Generate a mock file for the umi project',
+    description: `Generate a mock file for the ${frameworkName} project`,
     parameters: z.object({
       name: z.string().describe('Mock file name to generate'),
     }),
@@ -109,7 +113,7 @@ export const umiGenerate = async ({ server, root }: ToolContext) => {
   // Prettier 生成器、Jest 生成器、TailwindCSS 生成器、Dva 生成器、Precommit 生成器
   server.addTool({
     name: 'umi-generate-others',
-    description: 'Generate more tools for the umi project',
+    description: `Generate more tools for the ${frameworkName} project`,
     parameters: z.object({
       type: z
         .enum(['prettier', 'jest', 'tailwindcss', 'dva', 'precommit'])
diff --git a/src/tools/umi-help.ts b/src/tools/umi-help.ts
@@ -3,10 +3,10 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiHelp = async ({ server, root }: ToolContext) => {
+export const umiHelp = async ({ server, root, frameworkName }: ToolContext) => {
   server.addTool({
     name: 'umi-help',
-    description: 'Get help description for umi',
+    description: `Get help description for ${frameworkName}`,
     parameters: z.object({}),
     execute: async () => {
       const { binPath } = parse(root);
diff --git a/src/tools/umi-lint.ts b/src/tools/umi-lint.ts
@@ -3,10 +3,10 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiLint = async ({ server, root }: ToolContext) => {
+export const umiLint = async ({ server, root, frameworkName }: ToolContext) => {
   server.addTool({
     name: 'umi-lint',
-    description: 'Run the linting of the umi project',
+    description: `Run the linting of the ${frameworkName} project`,
     parameters: z.object({
       fix: z.boolean().optional().describe('Fix lint automatically'),
       eslintOnly: z
diff --git a/src/tools/umi-plugin.ts b/src/tools/umi-plugin.ts
@@ -3,10 +3,14 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiPlugin = async ({ server, root }: ToolContext) => {
+export const umiPlugin = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   server.addTool({
     name: 'umi-plugin-list',
-    description: 'List all plugins of the umi project',
+    description: `List all plugins of the ${frameworkName} project`,
     parameters: z.object({}),
     execute: async () => {
       const { binPath } = parse(root);
diff --git a/src/tools/umi-setup.ts b/src/tools/umi-setup.ts
@@ -3,11 +3,14 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiSetup = async ({ server, root }: ToolContext) => {
+export const umiSetup = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   server.addTool({
     name: 'umi-setup',
-    description:
-      'Setup the umi project and generate the tmp files in the `.umi` directory',
+    description: `Setup the ${frameworkName} project and generate tmp files in the .umi directory`,
     parameters: z.object({}),
     execute: async () => {
       const { binPath } = parse(root);
diff --git a/src/tools/umi-version.ts b/src/tools/umi-version.ts
@@ -3,10 +3,14 @@ import { z } from 'zod';
 import { parse } from '../parse';
 import { ToolContext } from '../types';
 
-export const umiVersion = async ({ server, root }: ToolContext) => {
+export const umiVersion = async ({
+  server,
+  root,
+  frameworkName,
+}: ToolContext) => {
   server.addTool({
     name: 'umi-version',
-    description: 'Get the version of the umi project.',
+    description: `Get the version of the ${frameworkName} project.`,
     parameters: z.object({}),
     execute: async () => {
       const { binPath } = parse(root);
diff --git a/types.d.ts b/types.d.ts
@@ -2,7 +2,7 @@
 export type ToolContext = {
   server: any;
   root: string;
+  frameworkName: string;
 };
 
-export function registerTools(toolContext: ToolContext) {
-}
+export function registerTools(toolContext: ToolContext): void;
