fix(workflow): preserve tool descriptions on add

Author: FinleyGe

packages/global/core/app/tool/httpTool/utils.ts

@@ -66,6 +66,7 @@ export const getHTTPToolRuntimeNode = ({
     flowNodeType: FlowNodeTypeEnum.tool,
     avatar,
     intro: tool.description,
+    toolDescription: tool.description,
     toolConfig: {
       httpTool: {
         toolId: `${AppToolSourceEnum.http}-${toolSetId}/${tool.name}`

packages/global/core/app/tool/mcpTool/utils.ts

@@ -59,6 +59,7 @@ export const getMCPToolRuntimeNode = ({
     flowNodeType: FlowNodeTypeEnum.tool,
     avatar,
     intro: tool.description,
+    toolDescription: tool.description,
     toolConfig: {
       mcpTool: {
         toolId: `${AppToolSourceEnum.mcp}-${toolSetId}/${tool.name}` // When runtool is used, parentId and toolname will be employed

packages/global/core/workflow/type/node.ts

@@ -235,6 +235,7 @@ export const NodeTemplateListItemTypeSchema = z.object({
   avatar: z.string().optional(),
   name: z.string(),
   intro: z.string().optional(), // template list intro
+  toolDescription: z.string().optional(), // tool description
   isTool: BoolSchema.optional(),
 
   authorAvatar: z.string().optional(),

packages/global/core/workflow/utils.ts

@@ -355,7 +355,9 @@ export const toolData2FlowNodeIO = ({ nodes }: { nodes: StoreNodeItemType[] }) =
   return {
     inputs: toolNode?.inputs || [],
     outputs: toolNode?.outputs || [],
-    toolConfig: toolNode?.toolConfig
+    toolConfig: toolNode?.toolConfig,
+    ...(toolNode?.intro ? { intro: toolNode.intro } : {}),
+    ...(toolNode?.toolDescription ? { toolDescription: toolNode.toolDescription } : {})
   };
 };
 

packages/service/core/app/tool/utils/client.ts

@@ -163,6 +163,7 @@ export async function getClientSystemToolPreviewNode({
   ];
   const isWorkflowTool = !!toolDetail.associatedPluginId;
   const toolConfigSource = isDebugToolSource(toolSource) ? toolSource : undefined;
+  const toolDescription = toolDetail.toolDescription || toolDetail.intro;
 
   return {
     id: getNanoid(),
@@ -176,7 +177,7 @@ export async function getClientSystemToolPreviewNode({
     avatar: toolDetail.avatar,
     name: toolDetail.name,
     intro: toolDetail.intro,
-    toolDescription: toolDetail.toolDescription,
+    toolDescription,
     courseUrl: toolDetail.courseUrl,
     readmeUrl: toolDetail.readmeUrl,
     userGuide: toolDetail.userGuide ?? undefined,
@@ -215,7 +216,7 @@ export async function getClientSystemToolPreviewNode({
                     ...(toolConfigSource ? { source: toolConfigSource } : {}),
                     toolList:
                       toolDetail.children?.map((child) => ({
-                        description: child.description ?? '',
+                        description: child.toolDescription || child.description || '',
                         name: child.name,
                         toolId: child.id
                       })) ?? []
@@ -355,6 +356,8 @@ export async function getClientToolPreviewNode({
           avatar: item.avatar,
           id: appId,
           name: tool.name,
+          intro: tool.description,
+          toolDescription: tool.description,
           templateType: FlowNodeTemplateTypeEnum.tools,
           workflow: {
             nodes: [
@@ -401,6 +404,8 @@ export async function getClientToolPreviewNode({
           avatar: item.avatar,
           id: appId,
           name: tool.name,
+          intro: tool.description,
+          toolDescription: tool.description,
           templateType: FlowNodeTemplateTypeEnum.tools,
           workflow: {
             nodes: [
@@ -435,6 +440,8 @@ export async function getClientToolPreviewNode({
         inputs: FlowNodeInputItemType[];
         outputs: FlowNodeOutputItemType[];
         toolConfig?: NodeToolConfigType;
+        intro?: string;
+        toolDescription?: string;
         showSourceHandle?: boolean;
         showTargetHandle?: boolean;
       };

packages/service/test/core/app/tool/utils/client.test.ts

@@ -116,7 +116,54 @@ describe('getClientToolPreviewNode', () => {
     expect(result.toolConfig?.httpTool).toEqual({
       toolId: 'http-507f1f77bcf86cd799439011/search'
     });
+    expect(result.intro).toBe('Search tool');
+    expect(result.toolDescription).toBe('Search tool');
     expect(result.inputs[0]?.key).toBe('q');
     expect((result as any).jsonSchema).toBeUndefined();
   });
+
+  it('writes mcp tool description onto the preview node', async () => {
+    mocks.findById.mockReturnValueOnce({
+      lean: vi.fn().mockResolvedValue({
+        _id: '507f1f77bcf86cd799439011',
+        teamId: '507f1f77bcf86cd799439012',
+        type: AppTypeEnum.mcpToolSet,
+        name: 'MCP Tools',
+        avatar: 'mcp.svg',
+        intro: 'MCP toolset'
+      })
+    });
+    mocks.getAppVersionById.mockResolvedValueOnce({
+      nodes: [
+        {
+          toolConfig: {
+            mcpToolSet: {
+              toolList: [
+                {
+                  name: 'search',
+                  description: 'Search MCP resources',
+                  inputSchema: { type: 'object', properties: { q: { type: 'string' } } }
+                }
+              ]
+            }
+          }
+        }
+      ],
+      edges: [],
+      chatConfig: {},
+      versionId: 'version-id',
+      versionName: 'Version 1'
+    });
+
+    const result = await getClientToolPreviewNode({
+      appId: 'mcp-507f1f77bcf86cd799439011/search',
+      lang: 'en'
+    });
+
+    expect(result.intro).toBe('Search MCP resources');
+    expect(result.toolDescription).toBe('Search MCP resources');
+    expect(result.toolConfig?.mcpTool).toEqual({
+      toolId: 'mcp-507f1f77bcf86cd799439011/search'
+    });
+  });
 });

packages/service/test/core/app/tool/utils/clientSystemTool.test.ts

@@ -254,7 +254,8 @@ describe('getClientSystemToolPreviewNode', () => {
         {
           id: 'web',
           name: 'Web Search',
-          description: 'Search web'
+          description: 'Search web',
+          toolDescription: 'Search web for model'
         }
       ]
     });
@@ -269,7 +270,14 @@ describe('getClientSystemToolPreviewNode', () => {
     expect(result.source).toBe('debug:tmbId:tmb-1');
     expect(result.toolConfig?.systemToolSet).toMatchObject({
       toolId: 'systemTool-search',
-      source: 'debug:tmbId:tmb-1'
+      source: 'debug:tmbId:tmb-1',
+      toolList: [
+        {
+          toolId: 'web',
+          name: 'Web Search',
+          description: 'Search web for model'
+        }
+      ]
     });
   });
 

projects/app/src/pages/api/core/app/tool/getSystemToolTemplates.ts

@@ -67,7 +67,7 @@ export async function handler(
           flowNodeType: FlowNodeTypeEnum.tool,
           name: child.name,
           intro: child.description,
-          toolDescription: child.toolDescription,
+          toolDescription: child.toolDescription || child.description,
           id: `${parentId}/${child.id}`,
           source: parent.source,
           avatar: child.icon ?? parent.avatar,
@@ -107,7 +107,7 @@ export async function handler(
       name: tool.name,
       intro: tool.intro,
       instructions: tool.userGuide ?? '',
-      toolDescription: tool.toolDescription,
+      toolDescription: tool.toolDescription || tool.intro,
       tags: tool.tags
     }))
     .filter((item) => filterTemplateBySearchKey(item, searchRegex));

projects/app/test/api/core/app/tool/getSystemToolTemplates.test.ts

@@ -107,6 +107,7 @@ describe('get system tool templates handler', () => {
     } as ApiRequestProps<GetSystemPluginTemplatesBody>);
 
     expect(result.map((item) => item.id)).toEqual(['weather']);
+    expect(result[0]?.toolDescription).toBe('Get weather');
     expect(mocks.getSystemToolList).toHaveBeenCalledWith({
       lang: 'zh',
       op: 'or',
@@ -244,6 +245,7 @@ describe('get system tool templates handler', () => {
     expect(result.map((item) => item.id)).toEqual(['toolset/plus']);
     expect(result[0]).toMatchObject({
       avatar: 'plus-icon',
+      toolDescription: 'Use literal plus',
       currentCost: 2,
       systemKeyCost: 0.5,
       hasTokenFee: true