Merge pull request #3254 from SalesforceCommerceCloud/t/commerce/W-19545821/updateToolDescription

@W-19545821 - Refactoring parameter names

Author: snilakandan13

packages/pwa-kit-mcp/src/server/server.test.js

@@ -60,7 +60,7 @@ describe('PwaStorefrontMCPServerHighLevel integration', () => {
         expect(response.result).toHaveProperty('tools')
         // Check that at least the DeveloperGuidelinesTool is present
         const toolNames = response.result.tools.map((t) => t.name)
-        expect(toolNames).toContain('development_guidelines')
+        expect(toolNames).toContain('get_development_guidelines')
 
         child.kill()
     }, 10000)

packages/pwa-kit-mcp/src/tools/create-app-guideline.js

@@ -72,11 +72,11 @@ class CreateAppGuidelinesTool {
     name = 'create_storefront_app'
     description = `
     
-This tool is used to provide the agent with the instructions on how to use the @salesforce/pwa-kit-create-app CLI tool to create a new PWA Kit projects.
+This tool is used to provide the agent with the instructions on how to use the @salesforce/pwa-kit-create-app CLI tool to create a new PWA Kit project.
 
 Do not attempt to create a project without using this tool first.
 
-Example Triggers:
+Example prompts:
 - "Create a new PWA Kit app"
 - "Start a new storefront using a preset"
 - "What templates are available for PWA Kit?"

packages/pwa-kit-mcp/src/tools/create-new-component.js

@@ -43,21 +43,21 @@ What is the main purpose of this component? Reply with exactly one of the follow
 
 class CreateNewComponentTool {
     constructor() {
-        this.name = 'create_sample_component'
+        this.name = 'create_component'
         this.description =
             'Create a sample React component. Gather information from user for the MCP tool parameters **one at a time**, in a natural and conversational way. Do **not** ask all the questions at once.'
         this.inputSchema = {
-            componentName: z.string().min(1, 'The name of the new Component to create?'),
+            componentName: z.string().min(1, 'The name of the new component to create?'),
             purpose: z
                 .string()
                 .min(
                     1,
-                    'The Purpose of the new component (e.g., Display a single Product, Display a list of Products or something else)'
+                    'The purpose of the new component (e.g., display a single Product, display a list of products or something else)'
                 )
                 .describe(systemPromptForComponentPurpose),
             location: z
                 .string()
-                .describe('The location of the component to be created')
+                .describe('The location of the component to create')
                 .default(process.env.PWA_STOREFRONT_APP_PATH)
         }
         this.handler = async (args) => {

packages/pwa-kit-mcp/src/tools/create-new-page-tool.js

@@ -32,9 +32,9 @@ const systemPromptForCreatePage = `You are a smart assistant that can use tools
         - Is ccExtensibility.overridesDir set in your package.json? (true/false) \
         Collect answers to these questions, then call the tool with the collected information as input parameters.`
 
-const systemPromptForProductHook = `User have added the ProductView component to the new page. Please ask user: \
+const systemPromptForProductHook = `User has added the ProductView component to the new page. Please ask user: \
         "To make it work, would you like to add the hook useProduct to your page?" \
-        If user answers yes, please make sure do do following: \
+        If user answers yes, please make sure to do following: \
         1. add the useProduct with ALL parameters following product-detail's useProduct as example, \
         2. update ProductView tag to pass product and isProductLoading as props, \
         3. in routes.jsx, update the path for the new page with '/:productId'. \
@@ -71,19 +71,19 @@ const systemPromptForUnfoundComponents = (unfoundComponents) =>
 
 class CreateNewPageTool {
     constructor() {
-        this.name = 'create_sample_page'
+        this.name = 'create_page'
         this.description =
             'Create a sample PWA storefront page. Gather information from user for the MCP tool parameters **one at a time**, in a natural and conversational way. Do **not** ask all the questions at once.'
         this.inputSchema = {
-            pageName: z.string().describe('The name of the new page to create?'),
+            pageName: z.string().describe('The name of the new page to create'),
             componentList: z
                 .array(z.string())
                 .describe(
                     'The existing components to include on the page, separated by commas. Component names should be in PascalCase (e.g., AddressDisplay, ProductView, Footer)'
                 ),
             route: z
                 .string()
-                .describe('The URL route for this page? (e.g., /new-home, /my-product-view)'),
+                .describe('The URL route for this page (e.g., /new-home, /my-product-view)'),
             nodeModulesPath: z.string().describe('The absolute path to the node_modules directory'),
             componentsPath: z.string().describe('The absolute path to the components directory'),
             pagesPath: z.string().describe('The absolute path to the pages directory'),

packages/pwa-kit-mcp/src/tools/create-new-page-tool.test.js

@@ -117,10 +117,17 @@ describe('CreateNewPageTool', () => {
         jest.spyOn(createNewPageTool, 'generatePageContent').mockResolvedValue(
             `const productId = '25592300M';\nexport default function Page() { return <div>{productId}</div>; }`
         )
+        const internalPaths = {
+            nodeModulesPath: '/mock/node_modules',
+            componentsPath: '/mock/app/components',
+            pagesPath: '/mock/app/pages',
+            routesPath: '/mock/app/routes.jsx',
+            hasOverridesDir: false
+        }
         const pageContent = await createNewPageTool.generatePageContent(
             'Test',
             ['ProductView'],
-            mockAbsolutePaths
+            internalPaths
         )
         expect(pageContent).toContain('25592300M')
         expect(pageContent).not.toMatch(/error|exception|fail/i)
@@ -131,10 +138,17 @@ describe('CreateNewPageTool', () => {
         jest.spyOn(createNewPageTool, 'generatePageContent').mockResolvedValue(
             `import Image from 'somewhere';\n${imageComponentString}`
         )
+        const internalPaths = {
+            nodeModulesPath: '/mock/node_modules',
+            componentsPath: '/mock/app/components',
+            pagesPath: '/mock/app/pages',
+            routesPath: '/mock/app/routes.jsx',
+            hasOverridesDir: false
+        }
         const pageContent = await createNewPageTool.generatePageContent(
             'Test',
             ['Image'],
-            mockAbsolutePaths
+            internalPaths
         )
         expect(pageContent).toContain('Image')
         expect(pageContent).toContain('static/img/hero.png')
@@ -146,10 +160,17 @@ describe('CreateNewPageTool', () => {
             `import Image from 'somewhere';\n${defaultImageString}`
         )
         // Simulate user says no to custom image (in real flow, this would be a follow-up, here we just check the generated content)
+        const internalPaths = {
+            nodeModulesPath: '/mock/node_modules',
+            componentsPath: '/mock/app/components',
+            pagesPath: '/mock/app/pages',
+            routesPath: '/mock/app/routes.jsx',
+            hasOverridesDir: false
+        }
         const pageContent = await createNewPageTool.generatePageContent(
             'Test',
             ['Image'],
-            mockAbsolutePaths
+            internalPaths
         )
         expect(pageContent).toContain('static/img/hero.png')
         expect(pageContent).not.toMatch(/https?:\/\//)
@@ -159,10 +180,17 @@ describe('CreateNewPageTool', () => {
         if (createNewPageTool.generatePageContent.mockRestore) {
             createNewPageTool.generatePageContent.mockRestore()
         }
+        const internalPaths = {
+            nodeModulesPath: '/mock/node_modules',
+            componentsPath: '/mock/app/components',
+            pagesPath: '/mock/app/pages',
+            routesPath: '/mock/app/routes.jsx',
+            hasOverridesDir: false
+        }
         const pageContent = await createNewPageTool.generatePageContent(
             'Test',
             ['Test'],
-            mockAbsolutePaths
+            internalPaths
         )
         expect(pageContent).toContain('import TestComponent from')
         expect(pageContent).toContain('<TestComponent />')
@@ -213,10 +241,17 @@ describe('CreateNewPageTool', () => {
         imgSrc: ["'self'", "https://edge.disstg.commercecloud.salesforce.com"]
       }
     }`
+        const internalPaths = {
+            nodeModulesPath: '/mock/node_modules',
+            componentsPath: '/mock/app/components',
+            pagesPath: '/mock/app/pages',
+            routesPath: '/mock/app/routes.jsx',
+            hasOverridesDir: false
+        }
         const pageContent = await createNewPageTool.generatePageContent(
             'Test',
             ['Image'],
-            mockAbsolutePaths
+            internalPaths
         )
         expect(pageContent).toContain(customSrc)
         expect(ssrContent).toContain('.commercecloud.salesforce.com')
@@ -239,10 +274,17 @@ describe('CreateNewPageTool', () => {
         imgSrc: ["'self'", "https://some-other-domain.com"]
       }
     }`
+        const internalPaths = {
+            nodeModulesPath: '/mock/node_modules',
+            componentsPath: '/mock/app/components',
+            pagesPath: '/mock/app/pages',
+            routesPath: '/mock/app/routes.jsx',
+            hasOverridesDir: false
+        }
         const pageContent = await createNewPageTool.generatePageContent(
             'Test',
             ['Image'],
-            mockAbsolutePaths
+            internalPaths
         )
         const isAllowed = ssrContent.includes('.commercecloud.salesforce.com')
         expect(isAllowed).toBe(false)

packages/pwa-kit-mcp/src/tools/developer-guideline.js

@@ -106,9 +106,9 @@ This document offers guidelines in the development of Salesforce Commerce Compos
 `
 
 export default {
-    name: 'development_guidelines',
-    description: `You must follow this development guidelines before attempting to analyze/ generate / refactor / modify / fix code.
-    - e.g. "Create a customer service Chat component", "Find bugs in my_script.jsx", "Refactor my_script.jsx to use React Hooks"`,
+    name: 'get_development_guidelines',
+    description: `You must follow the PWA Kit development guidelines before attempting to analyze, generate, refactor, modify, or fix code.
+Example prompts: "Create a customer service Chat component", "Find bugs in my_script.jsx", and "Refactor my_script.jsx to use React Hooks".`,
     inputSchema: EmptyJsonSchema,
     fn: async () => ({
         content: [{type: 'text', text: guidelinesText}]

packages/pwa-kit-mcp/src/tools/developer-guideline.test.js

@@ -11,9 +11,9 @@ describe('PWA Development Guidelines', () => {
     describe('DeveloperGuidelinesTool', () => {
         it('should have correct structure', () => {
             expect(DeveloperGuidelinesTool).toMatchObject({
-                name: 'development_guidelines',
-                description: `You must follow this development guidelines before attempting to analyze/ generate / refactor / modify / fix code.
-    - e.g. "Create a customer service Chat component", "Find bugs in my_script.jsx", "Refactor my_script.jsx to use React Hooks"`,
+                name: 'get_development_guidelines',
+                description: `You must follow the PWA Kit development guidelines before attempting to analyze, generate, refactor, modify, or fix code.
+Example prompts: "Create a customer service Chat component", "Find bugs in my_script.jsx", and "Refactor my_script.jsx to use React Hooks".`,
                 inputSchema: EmptyJsonSchema,
                 fn: expect.any(Function)
             })