Sync the mcp package with develop branch

Author: vmarta

packages/pwa-kit-mcp/CHANGELOG.md

@@ -1,4 +1,5 @@
 ## v0.2.0 (Sep 4, 2025)
+- Normalize tool names; Add introduction section for PWA Kit MCP and resize the images on README. [#3239](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/3239)
 
 ## v0.1.1 (Aug 11, 2025)
 - Add missing `shelljs` dependency. [#3053](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/3053)

packages/pwa-kit-mcp/README.md

@@ -12,17 +12,22 @@ It allows AI agents to query context-aware services like this server to help dev
 👉 **[Read more at modelcontextprotocol.io](https://modelcontextprotocol.io/)**
 
 
+## What is PWA-Kit-MCP?
+
+PWA-Kit-MCP is a local STDIO MCP Server that communicates via STDIO and operates in conjunction with a running local process, making it a fully locally installed MCP server. It provides an initial suite of MCP tools intended to standardize and optimize the developer workflow for PWA Kit storefront development. These tools facilitate project creation, supply development guidelines, enable the generation of new components and pages, and support site validation through performance and accessibility testing.
+
+
 ## 🧰 Features
 
 The PWA Kit MCP Server offers the following intelligent tools tailored to Salesforce Commerce Cloud PWA development:
 
-* **`create_app_guidelines`**:
+* **`create_storefront_app`**:
   Guides agents and developers through creating a new PWA Kit project with `@salesforce/pwa-kit-create-app`.
 
-* **`create_new_sample_component`**:
+* **`create_sample_component`**:
   Walks developers through a brief Q\&A to scaffold a component using the commerce data model, layout, and structure.
 
-* **`create_sample_storefront_page`**:
+* **`create_sample_page`**:
   Interactive tool to generate a new PWA storefront page with custom routing and components.
 
 * **`development_guidelines`**:
@@ -32,10 +37,6 @@ The PWA Kit MCP Server offers the following intelligent tools tailored to Salesf
   Runs performance and accessibility audits on a provided site URL.
   *Example: `https://pwa-kit.mobify-storefront.com`*
 
-* **`git_version_control`**:
-  Manages the version control of your project using git.
-  If the project is not already a git repo, project files will be committed as a new local git repo together with a basic .gitignore. If the project is already a git repo, just commit the changes in the project.
-
 
 ## ▶️ Running the MCP Server
 
@@ -44,10 +45,10 @@ The PWA Kit MCP Server offers the following intelligent tools tailored to Salesf
 1. Open **Cursor**.
 
 2. Navigate to **Settings > Cursor Settings...**
-![](https://raw.githubusercontent.com/SalesforceCommerceCloud/pwa-kit/refs/heads/develop/packages/pwa-kit-mcp/docs/images/cursor-settings.png)
+<img src="https://raw.githubusercontent.com/SalesforceCommerceCloud/pwa-kit/refs/heads/develop/packages/pwa-kit-mcp/docs/images/cursor-settings.png" alt="Cursor Settings Screenshot" width="50%" />
 
 3. Go to **Tools & Integrations > MCP Tools > New MCP Server**
-![](https://raw.githubusercontent.com/SalesforceCommerceCloud/pwa-kit/refs/heads/develop/packages/pwa-kit-mcp/docs/images/cursor-mcp-tools.png)
+<img src="https://raw.githubusercontent.com/SalesforceCommerceCloud/pwa-kit/refs/heads/develop/packages/pwa-kit-mcp/docs/images/cursor-mcp-tools.png" alt="Cursor MCP Tools Screenshot" width="50%" />
 
 4. Update your `mcp.json` like this (edit the placeholders as needed):
 ```json
@@ -86,7 +87,7 @@ Then send JSON-RPC requests like:
 
 ```json
 {"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}
-{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "create_new_component", "arguments": {}}}
+{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "create_sample_component", "arguments": {}}}
 ```
 
 ---
@@ -127,6 +128,5 @@ the output on "MCP Logs".
 | `package.json` | Node.js dependencies and project scripts                              |
 | `mcp.json`     | MCP client configuration (used by Cursor or other IDEs)               |
 | `src/server/`  | Main server entry point (`server.js`)                                 |
-| `src/tools/`   | Contains all MCP tools like `create-app-guideline`, `site-test`, etc. |
-| `src/utils/`   | Shared utility functions                                              |
-| `
+| `src/tools/`   | Contains all MCP tools like `create-storefront-app`, `site-test`, etc. |
+| `src/utils/`   | Shared utility functions                                              |

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

@@ -14,8 +14,7 @@ import {
     CreateNewComponentTool,
     DeveloperGuidelinesTool,
     TestWithPlaywrightTool,
-    CreateNewPageTool,
-    VersionControlGitTool
+    CreateNewPageTool
 } from '../tools'
 
 // NOTE: This is a workaround to import JSON files as ES modules.
@@ -39,18 +38,18 @@ class PwaStorefrontMCPServerHighLevel {
             }
         )
         this.createNewComponentTool = new CreateNewComponentTool()
-        this.versionControlGitTool = new VersionControlGitTool()
+        this.createAppGuidelinesTool = new CreateAppGuidelinesTool()
         this.testWithPlaywrightTool = new TestWithPlaywrightTool()
         this.setupTools()
     }
 
     setupTools() {
         // Register CreateProjectTool
         this.server.tool(
-            CreateAppGuidelinesTool.name,
-            CreateAppGuidelinesTool.description,
-            CreateAppGuidelinesTool.inputSchema,
-            CreateAppGuidelinesTool.fn
+            this.createAppGuidelinesTool.name,
+            this.createAppGuidelinesTool.description,
+            this.createAppGuidelinesTool.inputSchema,
+            this.createAppGuidelinesTool.fn
         )
         this.server.tool(
             DeveloperGuidelinesTool.name,
@@ -79,12 +78,6 @@ class PwaStorefrontMCPServerHighLevel {
             CreateNewPageTool.inputSchema,
             CreateNewPageTool.handler
         )
-        this.server.tool(
-            this.versionControlGitTool.name,
-            this.versionControlGitTool.description,
-            this.versionControlGitTool.inputSchema,
-            this.versionControlGitTool.handler
-        )
     }
 
     async run() {

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

@@ -7,6 +7,9 @@
 
 // Project dependencies
 import {EmptyJsonSchema, getCreateAppCommand, isMonoRepo, runCommand} from '../utils/utils'
+import shell from 'shelljs'
+import fs from 'fs'
+import path from 'path'
 
 const CREATE_APP_COMMAND = getCreateAppCommand()
 const DISPLAY_PROGRAM_FLAG = '--displayProgram'
@@ -59,12 +62,15 @@ If the user requests a project using a **template**:
 - Presets and templates are mutually exclusive paths. Do not offer both options unless explicitly requested.
 - Do not pass any flags to the \`${CREATE_APP_COMMAND}\` CLI tool that are not listed in the program.json options".
 - Use the \`${COMMAND_RUNNER}\` command to run the \`${CREATE_APP_COMMAND}\` CLI tool when creating a new project.
-- After project creation, prompt the user if **they want to do version control through git** using the **version_control_git** MCP tool.
+- After project creation, **MANDATORY**: Always ask the user whether they want to do git version control and commit the files locally.**
+- If the user replies "yes" or confirms they want version control:
+  - Use the integrated version control function and call the \`setupVersionControl\` function to handle git setup
+- **IMPORTANT**: You cannot skip asking the user - this interaction is **mandatory** for every project creation.
 `
 
-export default {
-    name: 'create_app_guidelines',
-    description: `
+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.
 
@@ -74,9 +80,102 @@ Example Triggers:
 - "Create a new PWA Kit app"
 - "Start a new storefront using a preset"
 - "What templates are available for PWA Kit?"
-- "What presets are available for PWA Kit?"`,
-    inputSchema: EmptyJsonSchema,
-    fn: async () => {
+- "What presets are available for PWA Kit?"`
+    inputSchema = EmptyJsonSchema
+
+    /**
+     * Handles the version control of your project using git.
+     * If the directory is not a git repo, it creates a basic .gitignore, runs git init, adds all files, and makes an initial commit.
+     * If already a git repo, it skips initialization and .gitignore creation, and just adds and commits all files locally.
+     * @param {string} directory - The directory to initialize the git repository in.
+     */
+    handleGitVersionControl(directory) {
+        if (!shell.which('git')) {
+            throw new Error(
+                'git is not installed or not found in PATH. Please install git to initialize a repository.'
+            )
+        }
+        const isGitRepo = fs.existsSync(path.join(directory, '.git'))
+        let result
+        if (isGitRepo) {
+            // Already a git repo: only add and commit
+            result = shell.exec('git add .', {cwd: directory, silent: true})
+            if (result.code !== 0) {
+                throw new Error(`git add failed: ${result.stderr || result.stdout}`)
+            }
+            result = shell.exec('git commit -m "Initial commit"', {cwd: directory, silent: true})
+            if (result.code !== 0) {
+                throw new Error(`git commit failed: ${result.stderr || result.stdout}`)
+            }
+        } else {
+            // Not a git repo: create .gitignore, init, add, commit
+            this.createBasicGitignore(directory)
+            result = shell.exec('git init', {cwd: directory, silent: true})
+            if (result.code !== 0) {
+                throw new Error(`git init failed: ${result.stderr || result.stdout}`)
+            }
+            result = shell.exec('git add .', {cwd: directory, silent: true})
+            if (result.code !== 0) {
+                throw new Error(`git add failed: ${result.stderr || result.stdout}`)
+            }
+            result = shell.exec('git commit -m "Initial commit"', {cwd: directory, silent: true})
+            if (result.code !== 0) {
+                throw new Error(`git commit failed: ${result.stderr || result.stdout}`)
+            }
+        }
+    }
+
+    /**
+     * Creates a basic .gitignore file in the given directory.
+     * @param {string} directory - The directory to create the .gitignore file in.
+     */
+    createBasicGitignore(directory) {
+        const gitignorePath = path.join(directory, '.gitignore')
+        if (!fs.existsSync(gitignorePath)) {
+            fs.writeFileSync(
+                gitignorePath,
+                `# Node
+node_modules/
+.env
+.DS_Store
+npm-debug.log
+yarn-debug.log
+yarn-error.log
+coverage/
+dist/
+build/
+.next/
+out/
+logs/
+*.log
+.idea/
+.vscode/
+`
+            )
+        }
+    }
+
+    /**
+     * Integrated version control function that can be called after project creation
+     * @param {string} projectDirectory - The directory where the project was created
+     * @returns {Object} Result object with success status and message
+     */
+    async setupVersionControl(projectDirectory) {
+        try {
+            this.handleGitVersionControl(projectDirectory)
+            return {
+                success: true,
+                message: 'Git version control initialized and committed locally.'
+            }
+        } catch (error) {
+            return {
+                success: false,
+                message: `Error: ${error.message}`
+            }
+        }
+    }
+
+    fn = async () => {
         // Run the display program and get the output.
         const programOutput = await runCommand(COMMAND_RUNNER, [
             ...(COMMAND_RUNNER === 'npx' ? ['--yes'] : []),
@@ -110,3 +209,5 @@ Example Triggers:
         }
     }
 }
+
+export default CreateAppGuidelinesTool