feat: add Lightning Component Generation tool with customizable templates and output directory

Author: akutishevsky

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.2] - 2025-08-31
+
+### Added
+
+- **Lightning Component Generation**: New tool for generating Lightning Web Components (LWC) and Aura components
+    - `generate_component` - Generate Lightning component bundles with metadata
+    - Supports both LWC and Aura component types
+    - Configurable templates (default, analyticsDashboard, analyticsDashboardWithStep)
+    - Custom output directory support with default fallback to current directory
+    - Respects READ_ONLY permissions
+
 ## [1.3.1] - 2025-08-21
 
 ### Fixed

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@advanced-communities/salesforce-mcp-server",
-    "version": "1.3.1",
+    "version": "1.3.2",
     "description": "MCP server enabling AI assistants to interact with Salesforce orgs through the Salesforce CLI",
     "main": "./src/index.ts",
     "scripts": {

src/index.ts

@@ -12,6 +12,7 @@ import { registerScannerTools } from "./tools/scanner.js";
 import { registerPackageTools } from "./tools/package.js";
 import { registerSchemaTools } from "./tools/schema.js";
 import { registerSearchTools } from "./tools/search.js";
+import { registerLightningTools } from "./tools/lightning.js";
 import { permissions } from "./config/permissions.js";
 
 /**
@@ -23,7 +24,7 @@ function buildServerDescription(): string {
     const allowedOrgs = permissions.getAllowedOrgs();
     const permissionInfo = [];
 
-    let description = `Salesforce MCP Server v1.3.0 - AI-powered Salesforce automation via CLI integration\n`;
+    let description = `Salesforce MCP Server v1.3.2 - AI-powered Salesforce automation via CLI integration\n`;
     description += `Capabilities: Apex execution, SOQL queries, org management, code testing & coverage\n`;
 
     if (readOnlyMode) {
@@ -65,6 +66,7 @@ registerScannerTools(server);
 registerPackageTools(server);
 registerSchemaTools(server);
 registerSearchTools(server);
+registerLightningTools(server);
 
 async function main() {
     const transport = new StdioServerTransport();

src/tools/lightning.ts

@@ -0,0 +1,101 @@
+import { z } from "zod";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { getConnection } from "../shared/connection.js";
+import { permissions } from "../config/permissions.js";
+import { executeSfCommand, executeSfCommandRaw } from "../utils/sfCommand.js";
+
+const generateComponent = async (
+    name: string,
+    template: string,
+    outputDirectory: string,
+    type: string,
+) => {
+    let sfCommand = `sf lightning generate component --name ${name} --json `;
+
+    if (template && template.length > 0) {
+        sfCommand += `--template ${template} `;
+    }
+
+    if (outputDirectory && outputDirectory.length > 0) {
+        sfCommand += `--output-dir ${outputDirectory} `;
+    }
+
+    if (type && type.length > 0) {
+        sfCommand += `--type ${type}`;
+    }
+
+    try {
+        const result = await executeSfCommand(sfCommand);
+        return result;
+    } catch (error) {
+        throw error;
+    }
+};
+
+export const registerLightningTools = (server: McpServer) => {
+    server.tool(
+        "generate_component",
+        "",
+        {
+            input: z.object({
+                name: z
+                    .string()
+                    .describe(
+                        "Name of the generated Lightning Component. The name can be up to 40 characters and must start with a letter.",
+                    ),
+                template: z
+                    .string()
+                    .optional()
+                    .describe(
+                        "Template to use for file creation. Supplied parameter values or default values are filled into a copy of the template. Permissible values are: default, analyticsDashboard, analyticsDashboardWithStep. Default value: default",
+                    ),
+                outputDirectory: z
+                    .string()
+                    .optional()
+                    .describe(
+                        "Directory for saving the created files. The location can be an absolute path or relative to the current working directory. The default is the current directory. Default value: .",
+                    ),
+                type: z
+                    .string()
+                    .optional()
+                    .describe(
+                        "Type of the component bundle. Permissible values are: aura, lwc (lightning web component). Default value: aura",
+                    ),
+            }),
+        },
+        async ({ input }) => {
+            const { name, template, outputDirectory, type } = input;
+            const DEFAULT_OUTPUT = ".";
+            if (permissions.isReadOnly()) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: JSON.stringify({
+                                success: false,
+                                compiled: false,
+                                compileProblem:
+                                    "Operation not allowed: Cannot generate components in READ_ONLY mode",
+                            }),
+                        },
+                    ],
+                };
+            }
+
+            const result = await generateComponent(
+                name,
+                template || "",
+                outputDirectory || DEFAULT_OUTPUT,
+                type || "",
+            );
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: JSON.stringify(result),
+                    },
+                ],
+            };
+        },
+    );
+};