@salesforce/b2c-dx-mcp 0.0.1 → 0.3.1

package/dist/tools/storefrontnext/index.js

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+/**
+ * Storefront Next toolset for B2C Commerce.
+ *
+ * This toolset provides MCP tools for Storefront Next development.
+ *
+ * **Implemented Tools:**
+ * - `storefront_next_development_guidelines` - Get development guidelines and best practices (GA)
+ *
+ * **Placeholder Tools (Use `--allow-non-ga-tools` flag to enable):**
+ * - `storefront_next_site_theming` - Configure site theming
+ * - `storefront_next_figma_to_component_workflow` - Convert Figma to components
+ * - `storefront_next_generate_component` - Generate new components
+ * - `storefront_next_map_tokens_to_theme` - Map design tokens
+ * - `storefront_next_design_decorator` - Apply design decorators
+ * - `storefront_next_generate_page_designer_metadata` - Generate Page Designer metadata
+ *
+ * @module tools/storefrontnext
+ */
+import { z } from 'zod';
+import { createToolAdapter, jsonResult } from '../adapter.js';
+import { createDeveloperGuidelinesTool } from './developer-guidelines.js';
+/**
+ * Creates a placeholder tool for Storefront Next development.
+ *
+ * Placeholder tools log invocations and return mock responses until
+ * the actual implementation is available.
+ *
+ * @param name - Tool name
+ * @param description - Tool description
+ * @param services - MCP services
+ * @returns The configured MCP tool
+ */
+function createPlaceholderTool(name, description, services) {
+    return createToolAdapter({
+        name,
+        description: `[PLACEHOLDER] ${description}`,
+        toolsets: ['STOREFRONTNEXT'],
+        isGA: false,
+        requiresInstance: false,
+        inputSchema: {
+            message: z.string().optional().describe('Optional message to echo'),
+        },
+        async execute(args) {
+            // Placeholder implementation
+            const timestamp = new Date().toISOString();
+            return {
+                tool: name,
+                status: 'placeholder',
+                message: `This is a placeholder implementation for '${name}'. The actual implementation is coming soon.`,
+                input: args,
+                timestamp,
+            };
+        },
+        formatOutput: (output) => jsonResult(output),
+    }, services);
+}
+/**
+ * Creates all tools for the STOREFRONTNEXT toolset.
+ *
+ * Note: mrt_bundle_push is defined in the MRT toolset with
+ * toolsets: ["MRT", "PWAV3", "STOREFRONTNEXT"] and will
+ * automatically appear in STOREFRONTNEXT.
+ *
+ * @param services - MCP services
+ * @returns Array of MCP tools
+ */
+export function createStorefrontNextTools(services) {
+    return [
+        createDeveloperGuidelinesTool(services),
+        createPlaceholderTool('storefront_next_site_theming', 'Configure and manage site theming for Storefront Next', services),
+        createPlaceholderTool('storefront_next_figma_to_component_workflow', 'Convert Figma designs to Storefront Next components', services),
+        createPlaceholderTool('storefront_next_generate_component', 'Generate a new Storefront Next component', services),
+        createPlaceholderTool('storefront_next_map_tokens_to_theme', 'Map design tokens to Storefront Next theme configuration', services),
+        createPlaceholderTool('storefront_next_design_decorator', 'Apply design decorators to Storefront Next components', services),
+        createPlaceholderTool('storefront_next_generate_page_designer_metadata', 'Generate Page Designer metadata for Storefront Next components', services),
+    ];
+}
+//# sourceMappingURL=index.js.map

package/dist/utils/constants.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Special toolset value that enables all toolsets.
+ */
+export declare const ALL_TOOLSETS = "ALL";
+/**
+ * Available toolsets that can be enabled.
+ */
+export declare const TOOLSETS: readonly ["CARTRIDGES", "MRT", "PWAV3", "SCAPI", "STOREFRONTNEXT"];
+/**
+ * Valid toolset names including the special "ALL" value.
+ */
+export declare const VALID_TOOLSET_NAMES: readonly ["ALL", "CARTRIDGES", "MRT", "PWAV3", "SCAPI", "STOREFRONTNEXT"];
+/**
+ * Type representing a valid toolset name.
+ */
+export type Toolset = (typeof TOOLSETS)[number];

package/dist/utils/constants.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+/**
+ * Special toolset value that enables all toolsets.
+ */
+export const ALL_TOOLSETS = 'ALL';
+/**
+ * Available toolsets that can be enabled.
+ */
+export const TOOLSETS = ['CARTRIDGES', 'MRT', 'PWAV3', 'SCAPI', 'STOREFRONTNEXT'];
+/**
+ * Valid toolset names including the special "ALL" value.
+ */
+export const VALID_TOOLSET_NAMES = [ALL_TOOLSETS, ...TOOLSETS];
+//# sourceMappingURL=constants.js.map

package/dist/utils/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Utility modules for the B2C DX MCP server.
+ *
+ * @module utils
+ */
+export * from './constants.js';
+export * from './types.js';

package/dist/utils/index.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+/**
+ * Utility modules for the B2C DX MCP server.
+ *
+ * @module utils
+ */
+// Note: We use .js extensions in imports for ESM compatibility.
+// TypeScript resolves .js → .ts at compile time, but the compiled
+// output needs .js extensions to work at runtime with Node.js ESM.
+export * from './constants.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/utils/types.d.ts

@@ -0,0 +1,45 @@
+import type { z, ZodRawShape } from 'zod';
+import type { CallToolResult } from '@modelcontextprotocol/sdk/types.js';
+import type { Toolset } from './constants.js';
+/**
+ * Result returned from MCP tool execution.
+ * Matches the MCP SDK's CallToolResult type.
+ */
+export type ToolResult = CallToolResult;
+/**
+ * Configuration for an MCP tool.
+ */
+export interface McpToolConfig<T extends ZodRawShape = ZodRawShape> {
+    /** Tool name (used in MCP protocol) */
+    name: string;
+    /** Human-readable description */
+    description: string;
+    /** Zod schema for input validation */
+    inputSchema: T;
+    /** Toolsets this tool belongs to */
+    toolsets: Toolset[];
+    /** Whether this tool is GA (generally available) */
+    isGA?: boolean;
+}
+/**
+ * MCP Tool definition with handler.
+ */
+export interface McpTool<T extends ZodRawShape = ZodRawShape> extends McpToolConfig<T> {
+    /** Handler function that executes the tool */
+    handler: (args: z.infer<z.ZodObject<T>>) => Promise<ToolResult>;
+}
+/**
+ * Startup flags passed to the MCP server.
+ */
+export interface StartupFlags {
+    /** Comma-separated list of toolsets to enable */
+    toolsets?: string[];
+    /** Specific individual tools to enable */
+    tools?: string[];
+    /** Allow non-GA (experimental) tools */
+    allowNonGaTools?: boolean;
+    /** Path to config file (dw.json format) */
+    configPath?: string;
+    /** Project working directory for tools (auto-discovery, scaffolding, etc.) */
+    workingDirectory?: string;
+}

package/dist/utils/types.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2025, Salesforce, Inc.
+ * SPDX-License-Identifier: Apache-2
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/oclif.manifest.json

@@ -0,0 +1,377 @@
+{
+  "commands": {
+    "Symbol(SINGLE_COMMAND_CLI)": {
+      "aliases": [],
+      "args": {},
+      "description": "Salesforce B2C Commerce Cloud Developer Experience MCP Server - Expose B2C Commerce Developer Experience tools to AI assistants",
+      "examples": [
+        {
+          "description": "All toolsets",
+          "command": "<%= config.bin %> --toolsets all --allow-non-ga-tools"
+        },
+        {
+          "description": "MRT tools with project and API key",
+          "command": "<%= config.bin %> --toolsets MRT --project my-project --api-key your-api-key --allow-non-ga-tools"
+        },
+        {
+          "description": "MRT tools with project, environment, and API key",
+          "command": "<%= config.bin %> --toolsets MRT --project my-project --environment staging --api-key your-api-key --allow-non-ga-tools"
+        },
+        {
+          "description": "Cartridge tools with explicit config",
+          "command": "<%= config.bin %> --toolsets CARTRIDGES --config /path/to/dw.json --allow-non-ga-tools"
+        },
+        {
+          "description": "Debug logging",
+          "command": "<%= config.bin %> --toolsets all --allow-non-ga-tools --debug"
+        }
+      ],
+      "flags": {
+        "log-level": {
+          "description": "Set logging verbosity level",
+          "env": "SFCC_LOG_LEVEL",
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "trace",
+            "debug",
+            "info",
+            "warn",
+            "error",
+            "silent"
+          ],
+          "type": "option"
+        },
+        "debug": {
+          "char": "D",
+          "description": "Enable debug logging (shorthand for --log-level debug)",
+          "env": "SFCC_DEBUG",
+          "helpGroup": "GLOBAL",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "json": {
+          "description": "Output logs as JSON lines",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "lang": {
+          "char": "L",
+          "description": "Language for messages (e.g., en, de). Also respects LANGUAGE env var.",
+          "helpGroup": "GLOBAL",
+          "name": "lang",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "config": {
+          "description": "Path to config file (in dw.json format; defaults to ./dw.json)",
+          "env": "SFCC_CONFIG",
+          "helpGroup": "GLOBAL",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "instance": {
+          "char": "i",
+          "description": "Instance name from configuration file (i.e. dw.json, etc)",
+          "env": "SFCC_INSTANCE",
+          "helpGroup": "GLOBAL",
+          "name": "instance",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "working-directory": {
+          "description": "Project working directory",
+          "env": "SFCC_WORKING_DIRECTORY",
+          "helpGroup": "GLOBAL",
+          "name": "working-directory",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "extra-query": {
+          "description": "Extra query parameters as JSON (e.g., '{\"debug\":\"true\"}')",
+          "env": "SFCC_EXTRA_QUERY",
+          "helpGroup": "GLOBAL",
+          "hidden": true,
+          "name": "extra-query",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "extra-body": {
+          "description": "Extra body fields to merge as JSON (e.g., '{\"_internal\":true}')",
+          "env": "SFCC_EXTRA_BODY",
+          "helpGroup": "GLOBAL",
+          "hidden": true,
+          "name": "extra-body",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "extra-headers": {
+          "description": "Extra HTTP headers as JSON (e.g., '{\"X-Custom-Header\": \"value\"}')",
+          "env": "SFCC_EXTRA_HEADERS",
+          "helpGroup": "GLOBAL",
+          "hidden": true,
+          "name": "extra-headers",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-key": {
+          "description": "MRT API key",
+          "env": "SFCC_MRT_API_KEY",
+          "helpGroup": "AUTH",
+          "name": "api-key",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "project": {
+          "char": "p",
+          "description": "MRT project slug (or set mrtProject in dw.json)",
+          "env": "SFCC_MRT_PROJECT",
+          "name": "project",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "char": "e",
+          "description": "MRT environment (e.g., staging, production; or set mrtEnvironment in dw.json)",
+          "env": "SFCC_MRT_ENVIRONMENT",
+          "name": "environment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "cloud-origin": {
+          "description": "MRT cloud origin URL (or set mrtOrigin in dw.json; default: https://cloud.mobify.com)",
+          "env": "SFCC_MRT_CLOUD_ORIGIN",
+          "name": "cloud-origin",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "credentials-file": {
+          "description": "Path to MRT credentials file (overrides default ~/.mobify)",
+          "env": "MRT_CREDENTIALS_FILE",
+          "name": "credentials-file",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "client-id": {
+          "description": "Client ID for OAuth",
+          "env": "SFCC_CLIENT_ID",
+          "helpGroup": "AUTH",
+          "name": "client-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "client-secret": {
+          "description": "Client Secret for OAuth",
+          "env": "SFCC_CLIENT_SECRET",
+          "helpGroup": "AUTH",
+          "name": "client-secret",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "scope": {
+          "description": "OAuth scopes to request (comma-separated)",
+          "env": "SFCC_OAUTH_SCOPES",
+          "helpGroup": "AUTH",
+          "name": "scope",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "short-code": {
+          "description": "SCAPI short code",
+          "env": "SFCC_SHORTCODE",
+          "helpGroup": "AUTH",
+          "name": "short-code",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "tenant-id": {
+          "aliases": [
+            "tenant"
+          ],
+          "description": "Organization/tenant ID",
+          "env": "SFCC_TENANT_ID",
+          "helpGroup": "AUTH",
+          "name": "tenant-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "auth-methods": {
+          "description": "Allowed auth methods in priority order (comma-separated)",
+          "env": "SFCC_AUTH_METHODS",
+          "exclusive": [
+            "user-auth"
+          ],
+          "helpGroup": "AUTH",
+          "name": "auth-methods",
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "client-credentials",
+            "implicit",
+            "basic",
+            "api-key"
+          ],
+          "type": "option"
+        },
+        "user-auth": {
+          "description": "Use browser-based user authentication (implicit OAuth flow)",
+          "exclusive": [
+            "auth-methods"
+          ],
+          "helpGroup": "AUTH",
+          "name": "user-auth",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "account-manager-host": {
+          "description": "Account Manager hostname for OAuth (default: account.demandware.com)",
+          "env": "SFCC_ACCOUNT_MANAGER_HOST",
+          "helpGroup": "AUTH",
+          "name": "account-manager-host",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "server": {
+          "char": "s",
+          "description": "B2C instance hostname",
+          "env": "SFCC_SERVER",
+          "helpGroup": "INSTANCE",
+          "name": "server",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "webdav-server": {
+          "description": "Separate hostname for WebDAV (cert. hostname, etc)",
+          "env": "SFCC_WEBDAV_SERVER",
+          "helpGroup": "INSTANCE",
+          "name": "webdav-server",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "code-version": {
+          "char": "v",
+          "description": "Code version",
+          "env": "SFCC_CODE_VERSION",
+          "helpGroup": "INSTANCE",
+          "name": "code-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "username": {
+          "char": "u",
+          "description": "Username for Basic Auth (WebDAV)",
+          "env": "SFCC_USERNAME",
+          "helpGroup": "AUTH",
+          "name": "username",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "password": {
+          "char": "p",
+          "description": "Password/access key for Basic Auth (WebDAV)",
+          "env": "SFCC_PASSWORD",
+          "helpGroup": "AUTH",
+          "name": "password",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "certificate": {
+          "description": "Path to PKCS12 certificate for two-factor auth",
+          "env": "SFCC_CERTIFICATE",
+          "helpGroup": "AUTH",
+          "name": "certificate",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "passphrase": {
+          "description": "Passphrase for the certificate",
+          "env": "SFCC_CERTIFICATE_PASSPHRASE",
+          "helpGroup": "AUTH",
+          "name": "passphrase",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "selfsigned": {
+          "description": "Allow self-signed server certificates",
+          "env": "SFCC_SELFSIGNED",
+          "helpGroup": "AUTH",
+          "name": "selfsigned",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verify": {
+          "description": "Verify SSL certificates",
+          "helpGroup": "AUTH",
+          "name": "verify",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "toolsets": {
+          "description": "Toolsets to enable (comma-separated). Options: all, CARTRIDGES, MRT, PWAV3, SCAPI, STOREFRONTNEXT",
+          "env": "SFCC_TOOLSETS",
+          "name": "toolsets",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "tools": {
+          "description": "Individual tools to enable (comma-separated)",
+          "env": "SFCC_TOOLS",
+          "name": "tools",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "allow-non-ga-tools": {
+          "description": "Enable non-GA (experimental) tools",
+          "env": "SFCC_ALLOW_NON_GA_TOOLS",
+          "name": "allow-non-ga-tools",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "Symbol(SINGLE_COMMAND_CLI)",
+      "pluginAlias": "@salesforce/b2c-dx-mcp",
+      "pluginName": "@salesforce/b2c-dx-mcp",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false
+    }
+  },
+  "version": "0.3.1"
+}