@salesforce/b2c-dx-mcp 0.4.5 → 0.4.7

package/README.md

@@ -53,7 +53,7 @@ Always set `--project-directory` (or `SFCC_PROJECT_DIRECTORY`). MCP clients spaw
 | `SFCC_PASSWORD` | Password/access key for WebDAV |
 | `SFCC_CLIENT_ID` | OAuth client ID |
 | `SFCC_CLIENT_SECRET` | OAuth client secret |
-| `SFCC_MRT_API_KEY` | MRT API key |
+| `MRT_API_KEY` | MRT API key (`SFCC_MRT_API_KEY` also supported) |
 
 See the [Configuration Guide](https://salesforcecommercecloud.github.io/b2c-developer-tooling/mcp/configuration) for credentials, flags, and toolset selection.
 

package/dist/commands/mcp.d.ts

@@ -50,10 +50,10 @@ export default class McpServerCommand extends BaseCommand<typeof McpServerComman
         'extra-query': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'extra-body': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'extra-headers': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        'api-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-key': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         project: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         environment: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        'cloud-origin': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'cloud-origin': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         'credentials-file': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     /** Signal that triggered shutdown (if any) - used to exit process after finally() */
@@ -77,7 +77,7 @@ export default class McpServerCommand extends BaseCommand<typeof McpServerComman
      *
      * Priority (highest to lowest):
      * 1. CLI flags (--server, --username, --api-key, etc.)
-     * 2. Environment variables (SFCC_SERVER, SFCC_USERNAME, SFCC_MRT_API_KEY, etc.)
+     * 2. Environment variables (SFCC_SERVER, SFCC_USERNAME, MRT_API_KEY, etc.)
      * 3. dw.json file (via --config flag or auto-discovered from --project-directory)
      * 4. ~/.mobify file (for MRT API key)
      */

package/dist/commands/mcp.js

@@ -29,10 +29,10 @@
  * ### MRT Flags (from MrtCommand.baseFlags)
  * | Flag | Env Variable | Description |
  * |------|--------------|-------------|
- * | `--api-key` | `SFCC_MRT_API_KEY` | MRT API key for Managed Runtime operations |
- * | `--project` | `SFCC_MRT_PROJECT` | MRT project slug (required for MRT tools) |
- * | `--environment` | `SFCC_MRT_ENVIRONMENT` | MRT environment (e.g., staging, production) |
- * | `--cloud-origin` | `SFCC_MRT_CLOUD_ORIGIN` | MRT cloud origin URL for environment-specific ~/.mobify config |
+ * | `--api-key` | `MRT_API_KEY` | MRT API key for Managed Runtime operations |
+ * | `--project` | `MRT_PROJECT` | MRT project slug (required for MRT tools) |
+ * | `--environment` | `MRT_ENVIRONMENT` | MRT environment (e.g., staging, production) |
+ * | `--cloud-origin` | `MRT_CLOUD_ORIGIN` | MRT cloud origin URL for environment-specific ~/.mobify config |
  *
  * ### B2C Instance Flags (from InstanceCommand.baseFlags)
  * | Flag | Env Variable | Description |
@@ -79,7 +79,7 @@
  * ### MRT API Key
  * Priority (highest to lowest):
  * 1. `--api-key` flag
- * 2. `SFCC_MRT_API_KEY` environment variable
+ * 2. `MRT_API_KEY` environment variable (SFCC_MRT_API_KEY also supported)
  * 3. `~/.mobify` config file (or `~/.mobify--[hostname]` if `--cloud-origin` is set)
  *
  * ## Toolset Validation
@@ -101,7 +101,7 @@
  * ```json
  * {
  *   "args": ["--toolsets", "MRT", "--project", "my-project", "--environment", "staging", "--allow-non-ga-tools"],
- *   "env": { "SFCC_MRT_API_KEY": "your-api-key" }
+ *   "env": { "MRT_API_KEY": "your-api-key" }
  * }
  * ```
  *
@@ -232,7 +232,7 @@ export default class McpServerCommand extends BaseCommand {
      *
      * Priority (highest to lowest):
      * 1. CLI flags (--server, --username, --api-key, etc.)
-     * 2. Environment variables (SFCC_SERVER, SFCC_USERNAME, SFCC_MRT_API_KEY, etc.)
+     * 2. Environment variables (SFCC_SERVER, SFCC_USERNAME, MRT_API_KEY, etc.)
      * 3. dw.json file (via --config flag or auto-discovered from --project-directory)
      * 4. ~/.mobify file (for MRT API key)
      */

package/dist/services.d.ts

@@ -26,11 +26,11 @@
  * - Flags (highest priority) merged with dw.json (auto-discovered or via --config)
  *
  * **MRT Auth** (for Managed Runtime tools):
- * 1. `--api-key` flag (oclif also checks `SFCC_MRT_API_KEY` env var)
+ * 1. `--api-key` flag (oclif also checks `MRT_API_KEY` env var; `SFCC_MRT_API_KEY` also supported)
  * 2. `~/.mobify` config file (or `~/.mobify--[hostname]` if `--cloud-origin` is set)
  *
  * **MRT Origin** (for Managed Runtime API URL):
- * 1. `--cloud-origin` flag (oclif also checks `SFCC_MRT_CLOUD_ORIGIN` env var)
+ * 1. `--cloud-origin` flag (oclif also checks `MRT_CLOUD_ORIGIN` env var; `SFCC_MRT_CLOUD_ORIGIN` also supported)
  * 2. `mrtOrigin` field in dw.json
  * 3. Default: `https://cloud.mobify.com`
  *
@@ -48,11 +48,11 @@ import { WebDavClient, type CustomApisClient, type ScapiSchemasClient } from '@s
 export interface MrtConfig {
     /** Pre-resolved auth strategy for MRT API operations */
     auth?: AuthStrategy;
-    /** MRT project slug from --project flag or SFCC_MRT_PROJECT env var */
+    /** MRT project slug from --project flag or MRT_PROJECT env var */
     project?: string;
-    /** MRT environment from --environment flag or SFCC_MRT_ENVIRONMENT env var */
+    /** MRT environment from --environment flag or MRT_ENVIRONMENT env var */
     environment?: string;
-    /** MRT API origin URL from --cloud-origin flag, SFCC_MRT_CLOUD_ORIGIN env var, or mrtOrigin in dw.json */
+    /** MRT API origin URL from --cloud-origin flag, MRT_CLOUD_ORIGIN env var, or mrtOrigin in dw.json */
     origin?: string;
 }
 /**

package/dist/services.js

@@ -31,11 +31,11 @@
  * - Flags (highest priority) merged with dw.json (auto-discovered or via --config)
  *
  * **MRT Auth** (for Managed Runtime tools):
- * 1. `--api-key` flag (oclif also checks `SFCC_MRT_API_KEY` env var)
+ * 1. `--api-key` flag (oclif also checks `MRT_API_KEY` env var; `SFCC_MRT_API_KEY` also supported)
  * 2. `~/.mobify` config file (or `~/.mobify--[hostname]` if `--cloud-origin` is set)
  *
  * **MRT Origin** (for Managed Runtime API URL):
- * 1. `--cloud-origin` flag (oclif also checks `SFCC_MRT_CLOUD_ORIGIN` env var)
+ * 1. `--cloud-origin` flag (oclif also checks `MRT_CLOUD_ORIGIN` env var; `SFCC_MRT_CLOUD_ORIGIN` also supported)
  * 2. `mrtOrigin` field in dw.json
  * 3. Default: `https://cloud.mobify.com`
  *

package/dist/tools/adapter.d.ts

@@ -13,7 +13,7 @@
  * a loader function that calls {@link Services.fromResolvedConfig}:
  *
  * - **B2CInstance**: Loaded from flags + dw.json on each call. Available when `requiresInstance: true`.
- * - **MRT Auth**: Loaded from --api-key → SFCC_MRT_API_KEY → ~/.mobify on each call. Available when `requiresMrtAuth: true`.
+ * - **MRT Auth**: Loaded from --api-key → MRT_API_KEY → ~/.mobify on each call. Available when `requiresMrtAuth: true`.
  *
  * This "load on each call" pattern provides:
  * - Fresh configuration on each tool invocation (picks up changes to config files)
@@ -115,7 +115,7 @@ export interface ToolAdapterOptions<TInput, TOutput> {
     requiresInstance?: boolean;
     /**
      * Whether this tool requires MRT API authentication.
-     * When true, creates an ApiKeyStrategy from SFCC_MRT_API_KEY environment variable.
+     * When true, creates an ApiKeyStrategy from MRT_API_KEY environment variable.
      * Defaults to false.
      */
     requiresMrtAuth?: boolean;

package/dist/tools/adapter.js

@@ -18,7 +18,7 @@
  * a loader function that calls {@link Services.fromResolvedConfig}:
  *
  * - **B2CInstance**: Loaded from flags + dw.json on each call. Available when `requiresInstance: true`.
- * - **MRT Auth**: Loaded from --api-key → SFCC_MRT_API_KEY → ~/.mobify on each call. Available when `requiresMrtAuth: true`.
+ * - **MRT Auth**: Loaded from --api-key → MRT_API_KEY → ~/.mobify on each call. Available when `requiresMrtAuth: true`.
  *
  * This "load on each call" pattern provides:
  * - Fresh configuration on each tool invocation (picks up changes to config files)
@@ -200,7 +200,7 @@ export function createToolAdapter(options, loadServices) {
                 let mrtConfig;
                 if (requiresMrtAuth) {
                     if (!services.mrtConfig.auth) {
-                        return errorResult('MRT auth error: MRT API key required. Provide --api-key, set SFCC_MRT_API_KEY environment variable, or configure ~/.mobify');
+                        return errorResult('MRT auth error: MRT API key required. Provide --api-key, set MRT_API_KEY environment variable, or configure ~/.mobify');
                     }
                     mrtConfig = {
                         auth: services.mrtConfig.auth,

package/dist/tools/cartridges/index.js

@@ -14,6 +14,9 @@ import { z } from 'zod';
 import { createToolAdapter, jsonResult } from '../adapter.js';
 import { findAndDeployCartridges, getActiveCodeVersion } from '@salesforce/b2c-tooling-sdk/operations/code';
 import { getLogger } from '@salesforce/b2c-tooling-sdk/logging';
+/** Reminder shown after deploy so users add cartridges to the site cartridge path. */
+const CARTRIDGE_PATH_REMINDER = "If this is a new or updated cartridge, add it to your site's cartridge path in Business Manager: " +
+    'Sites → Manage Sites → [your site] → Settings tab → Cartridges field.';
 /**
  * Creates the cartridge_deploy tool.
  *
@@ -36,7 +39,8 @@ function createCartridgeDeployTool(loadServices, injections) {
             'Searches the directory for cartridges (by .project files), applies include/exclude filters, ' +
             'creates a zip archive, uploads via WebDAV, and optionally reloads the code version. ' +
             'Use this tool to deploy custom code cartridges for SFRA or other B2C Commerce code. ' +
-            'Requires the instance to have a code version configured.',
+            'Requires the instance to have a code version configured. ' +
+            "After deploy, add new cartridges to your site's cartridge path in Business Manager: Sites → Manage Sites → [site] → Settings tab → Cartridges.",
         toolsets: ['CARTRIDGES'],
         isGA: false,
         requiresInstance: true,
@@ -100,7 +104,10 @@ function createCartridgeDeployTool(loadServices, injections) {
                 }, '[Cartridges] Deploying cartridges with computed options');
                 // Deploy cartridges
                 const result = await findAndDeployCartridgesFn(instance, directory, options);
-                return result;
+                return {
+                    ...result,
+                    postInstructions: CARTRIDGE_PATH_REMINDER,
+                };
             }
             catch (error) {
                 // Handle communication and authentication errors

package/dist/tools/mrt/index.d.ts

@@ -2,12 +2,17 @@ import type { McpTool } from '../../utils/index.js';
 import type { Services } from '../../services.js';
 import type { PushResult, PushOptions } from '@salesforce/b2c-tooling-sdk/operations/mrt';
 import type { AuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
+import { type ProjectType } from '@salesforce/b2c-tooling-sdk/discovery';
 /**
  * Optional dependency injections for testing.
  */
 interface MrtToolInjections {
     /** Mock pushBundle function for testing */
     pushBundle?: (options: PushOptions, auth: AuthStrategy) => Promise<PushResult>;
+    /** Mock detectWorkspaceType function for testing */
+    detectWorkspaceType?: (path: string) => Promise<{
+        projectTypes: ProjectType[];
+    }>;
 }
 /**
  * Creates all tools for the MRT toolset.

package/dist/tools/mrt/index.js

@@ -13,7 +13,98 @@
 import { z } from 'zod';
 import { createToolAdapter, jsonResult } from '../adapter.js';
 import { pushBundle } from '@salesforce/b2c-tooling-sdk/operations/mrt';
+import { detectWorkspaceType } from '@salesforce/b2c-tooling-sdk/discovery';
 import { getLogger } from '@salesforce/b2c-tooling-sdk/logging';
+/**
+ * Parses a glob pattern string into an array of patterns.
+ * Accepts either a JSON array (e.g. '["server/**\/*", "ssr.{js,mjs}"]')
+ * or a comma-separated string (e.g. 'server/**\/*,ssr.js').
+ * JSON array format supports brace expansion in individual patterns.
+ */
+function parseGlobPatterns(value) {
+    const trimmed = value.trim();
+    if (trimmed.startsWith('[')) {
+        const parsed = JSON.parse(trimmed);
+        if (!Array.isArray(parsed) || !parsed.every((item) => typeof item === 'string')) {
+            throw new Error('Invalid glob pattern array: expected an array of strings');
+        }
+        return parsed.map((s) => s.trim()).filter(Boolean);
+    }
+    return trimmed
+        .split(',')
+        .map((s) => s.trim())
+        .filter(Boolean);
+}
+const MRT_DEFAULTS = {
+    'storefront-next': {
+        // ssrEntryPoint is 'streamingHandler' (production + MRT_BUNDLE_TYPE!=='ssr') or 'ssr' otherwise.
+        // Include both patterns so the bundle works regardless of MRT_BUNDLE_TYPE / mode.
+        ssrOnly: [
+            'server/**/*',
+            'loader.js',
+            'streamingHandler.{js,mjs,cjs}',
+            'streamingHandler.{js,mjs,cjs}.map',
+            'ssr.{js,mjs,cjs}',
+            'ssr.{js,mjs,cjs}.map',
+            '!static/**/*',
+            'sfnext-server-*.mjs',
+            '!**/*.stories.tsx',
+            '!**/*.stories.ts',
+            '!**/*-snapshot.tsx',
+            '!.storybook/**/*',
+            '!storybook-static/**/*',
+            '!**/__mocks__/**/*',
+            '!**/__snapshots__/**/*',
+        ],
+        ssrShared: [
+            'client/**/*',
+            'static/**/*',
+            '**/*.css',
+            '**/*.png',
+            '**/*.jpg',
+            '**/*.jpeg',
+            '**/*.gif',
+            '**/*.svg',
+            '**/*.ico',
+            '**/*.woff',
+            '**/*.woff2',
+            '**/*.ttf',
+            '**/*.eot',
+            '!**/*.stories.tsx',
+            '!**/*.stories.ts',
+            '!**/*-snapshot.tsx',
+            '!.storybook/**/*',
+            '!storybook-static/**/*',
+            '!**/__mocks__/**/*',
+            '!**/__snapshots__/**/*',
+        ],
+        buildDirectory: 'build',
+    },
+    'pwa-kit-v3': {
+        ssrOnly: ['ssr.js', 'ssr.js.map', 'node_modules/**/*.*'],
+        ssrShared: ['static/ico/favicon.ico', 'static/robots.txt', '**/*.js', '**/*.js.map', '**/*.json'],
+        buildDirectory: 'build',
+    },
+    default: {
+        ssrOnly: ['ssr.js', 'ssr.mjs', 'server/**/*'],
+        ssrShared: ['static/**/*', 'client/**/*'],
+        buildDirectory: 'build',
+    },
+};
+/**
+ * Returns MRT bundle defaults for the given project types.
+ * For hybrid projects (multiple types detected), prefers storefront-next over pwa-kit-v3.
+ *
+ * @param projectTypes - Detected project types from workspace discovery
+ * @returns Defaults for ssrOnly, ssrShared, and buildDirectory
+ */
+function getDefaultsForProjectTypes(projectTypes) {
+    if (projectTypes.includes('storefront-next'))
+        return MRT_DEFAULTS['storefront-next'];
+    if (projectTypes.includes('pwa-kit-v3'))
+        return MRT_DEFAULTS['pwa-kit-v3'];
+    return MRT_DEFAULTS.default;
+}
 /**
  * Creates the mrt_bundle_push tool.
  *
@@ -28,24 +119,28 @@ import { getLogger } from '@salesforce/b2c-tooling-sdk/logging';
  */
 function createMrtBundlePushTool(loadServices, injections) {
     const pushBundleFn = injections?.pushBundle || pushBundle;
+    const detectWorkspaceTypeFn = injections?.detectWorkspaceType ?? detectWorkspaceType;
     return createToolAdapter({
         name: 'mrt_bundle_push',
         description: 'Bundle a pre-built PWA Kit or Storefront Next project and push to Managed Runtime. Optionally deploy to a target environment.',
         toolsets: ['MRT', 'PWAV3', 'STOREFRONTNEXT'],
         isGA: false,
-        // MRT operations use ApiKeyStrategy from SFCC_MRT_API_KEY or ~/.mobify
+        // MRT operations use ApiKeyStrategy from MRT_API_KEY or ~/.mobify
         requiresMrtAuth: true,
         inputSchema: {
-            buildDirectory: z.string().optional().describe('Path to build directory (default: ./build)'),
+            buildDirectory: z
+                .string()
+                .optional()
+                .describe('Path to build directory. Defaults vary by project type: Storefront Next, PWA Kit v3, or generic (./build).'),
             message: z.string().optional().describe('Deployment message'),
             ssrOnly: z
                 .string()
                 .optional()
-                .describe('Glob patterns for server-only files, comma-separated (default: ssr.js,ssr.mjs,server/**/*)'),
+                .describe('Glob patterns for server-only files (comma-separated or JSON array). Defaults vary by project type: Storefront Next, PWA Kit v3, or generic.'),
             ssrShared: z
                 .string()
                 .optional()
-                .describe('Glob patterns for shared files, comma-separated (default: static/**/*,client/**/*)'),
+                .describe('Glob patterns for shared files (comma-separated or JSON array). Defaults vary by project type: Storefront Next, PWA Kit v3, or generic.'),
             deploy: z
                 .boolean()
                 .optional()
@@ -56,7 +151,7 @@ function createMrtBundlePushTool(loadServices, injections) {
             // Get project from --project flag (required)
             const project = context.mrtConfig?.project;
             if (!project) {
-                throw new Error('MRT project error: Project is required. Provide --project flag or set SFCC_MRT_PROJECT environment variable.');
+                throw new Error('MRT project error: Project is required. Provide --project flag or set MRT_PROJECT environment variable.');
             }
             // Get environment from --environment flag (optional)
             // When deploy is false, environment is undefined (bundle push only, no deployment)
@@ -66,15 +161,18 @@ function createMrtBundlePushTool(loadServices, injections) {
                 environment = context.mrtConfig?.environment;
                 if (!environment) {
                     throw new Error('MRT deployment error: Environment is required when deploy=true. ' +
-                        'Provide --environment flag, set SFCC_MRT_ENVIRONMENT environment variable, or set mrtEnvironment in dw.json.');
+                        'Provide --environment flag, set MRT_ENVIRONMENT environment variable, or set mrtEnvironment in dw.json.');
                 }
             }
             // Get origin from --cloud-origin flag or mrtOrigin config (optional)
             const origin = context.mrtConfig?.origin;
-            // Parse comma-separated glob patterns (same as CLI defaults)
-            const ssrOnly = (args.ssrOnly || 'ssr.js,ssr.mjs,server/**/*').split(',').map((s) => s.trim());
-            const ssrShared = (args.ssrShared || 'static/**/*,client/**/*').split(',').map((s) => s.trim());
-            const buildDirectory = context.services.resolveWithProjectDirectory(args.buildDirectory || 'build');
+            // Detect project type and get project-type-aware defaults
+            const projectDir = context.services.resolveWithProjectDirectory();
+            const { projectTypes } = await detectWorkspaceTypeFn(projectDir);
+            const defaults = getDefaultsForProjectTypes(projectTypes);
+            const ssrOnly = args.ssrOnly ? parseGlobPatterns(args.ssrOnly) : defaults.ssrOnly;
+            const ssrShared = args.ssrShared ? parseGlobPatterns(args.ssrShared) : defaults.ssrShared;
+            const buildDirectory = context.services.resolveWithProjectDirectory(args.buildDirectory ?? defaults.buildDirectory);
             // Log all computed variables before pushing bundle
             const logger = getLogger();
             logger.debug({
@@ -83,6 +181,7 @@ function createMrtBundlePushTool(loadServices, injections) {
                 origin,
                 buildDirectory,
                 message: args.message,
+                projectTypes,
                 ssrOnly,
                 ssrShared,
             }, '[MRT] Pushing bundle with computed options');

package/oclif.manifest.json

@@ -143,7 +143,7 @@
         },
         "api-key": {
           "description": "MRT API key",
-          "env": "SFCC_MRT_API_KEY",
+          "env": "MRT_API_KEY",
           "helpGroup": "AUTH",
           "name": "api-key",
           "hasDynamicHelp": false,
@@ -153,16 +153,19 @@
         "project": {
           "char": "p",
           "description": "MRT project slug (or set mrtProject in dw.json)",
-          "env": "SFCC_MRT_PROJECT",
+          "env": "MRT_PROJECT",
           "name": "project",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "environment": {
+          "aliases": [
+            "target"
+          ],
           "char": "e",
           "description": "MRT environment (e.g., staging, production; or set mrtEnvironment in dw.json)",
-          "env": "SFCC_MRT_ENVIRONMENT",
+          "env": "MRT_ENVIRONMENT",
           "name": "environment",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -170,7 +173,7 @@
         },
         "cloud-origin": {
           "description": "MRT cloud origin URL (or set mrtOrigin in dw.json; default: https://cloud.mobify.com)",
-          "env": "SFCC_MRT_CLOUD_ORIGIN",
+          "env": "MRT_CLOUD_ORIGIN",
           "name": "cloud-origin",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -387,5 +390,5 @@
       "enableJsonFlag": false
     }
   },
-  "version": "0.4.5"
+  "version": "0.4.7"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/b2c-dx-mcp",
   "description": "MCP server for B2C Commerce developer experience tools",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "author": "Salesforce",
   "license": "Apache-2.0",
   "repository": "SalesforceCommerceCloud/b2c-developer-tooling",
@@ -80,7 +80,7 @@
     "yaml": "2.8.1",
     "postcss": "8.5.6",
     "zod": "3.25.76",
-    "@salesforce/b2c-tooling-sdk": "0.5.4"
+    "@salesforce/b2c-tooling-sdk": "0.6.0"
   },
   "devDependencies": {
     "@eslint/compat": "^1",