Install AI Tools

B2C Commerce tools, documentation, and skills for your assistant.

Claude

Install the plugin Recommended

bash

claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
claude plugin install b2c-dx-mcp@b2c-developer-tooling

Start a new Claude Code session. To install for the current project only, run it from your project directory with --scope project.

Manual MCP setup

bash

claude mcp add --transport stdio --scope user b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new session. To configure the current project only, run it from your project directory with --scope project. See Claude Code MCP setup.

Claude Desktop setup

Codex

Install the plugin Recommended

bash

codex plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
codex plugin add b2c-dx-mcp@b2c-developer-tooling

Start a new Codex session in your project. This setup also works with the Codex IDE extension and the ChatGPT Work desktop app.

Manual MCP setup

bash

codex mcp add b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Or add this to ~/.codex/config.toml (or $CODEX_HOME/config.toml if customized):

toml

[mcp_servers.b2c-dx-mcp]
command = "npx"
args = ["-y", "@salesforce/b2c-dx-mcp@latest"]

Start a new session. See Codex MCP configuration.

ChatGPT online setup

VS Code

Install in VS Code

Install the plugin Recommended

Open the Command Palette (Cmd/Ctrl+Shift+P) and run Chat: Install Plugin from Source.
Enter SalesforceCommerceCloud/b2c-developer-tooling.
Select b2c-dx-mcp and follow the installation prompts.
Start a new chat in GitHub Copilot.

Manual MCP setup

Add this to .vscode/mcp.json in your workspace:

json

{
  "servers": {
    "b2c-dx-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@salesforce/b2c-dx-mcp@latest"]
    }
  }
}

See VS Code MCP setup.

Copilot CLI setup

Cursor

Install in Cursor

Reload the MCP server in Cursor after installation.

Manual MCP setup

Add this to .cursor/mcp.json in your project:

json

{
  "mcpServers": {
    "b2c-dx-mcp": {
      "command": "npx",
      "args": ["-y", "@salesforce/b2c-dx-mcp@latest"]
    }
  }
}

For all projects, use ~/.cursor/mcp.json instead.

See Cursor's MCP documentation.

OpenCode

Add this to opencode.json in your project:

json

{
  "mcp": {
    "b2c-dx-mcp": {
      "type": "local",
      "command": ["npx", "-y", "@salesforce/b2c-dx-mcp@latest"],
      "enabled": true
    }
  }
}

Restart OpenCode. For all projects, use ~/.config/opencode/opencode.json. See OpenCode MCP setup.

Gemini

Run:

bash

gemini mcp add --scope user b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new Gemini CLI session. To configure the current project only, run it from your project directory with --scope project. See Gemini CLI MCP setup.

No separate skills plugins needed.

Other clients and manual setup →

View as Markdown

View as Markdown

@salesforce/b2c-tooling-sdk / operations/cap

operations/cap

Commerce App Package (CAP) operations for B2C Commerce.

This module provides functions for validating, packaging, installing, and uninstalling Commerce App Packages (CAPs) on B2C Commerce instances.

CAP Operations

validateCap - Validate CAP structure and manifest (local, no instance required)
commerceAppInstall - Install a CAP via the sfcc-install-commerce-app job
commerceAppUninstall - Uninstall a CAP via the sfcc-uninstall-commerce-app job
commerceAppPackage - Package a CAP directory into a distributable .zip
discoverLocalApps - Discover local CAPs by finding commerce-app.json files
listInstalledApps - List installed apps on an instance via commerce_feature_states export

Usage

typescript

import {
  validateCap,
  commerceAppInstall,
  commerceAppUninstall,
  commerceAppPackage,
  discoverLocalApps,
  listInstalledApps,
} from '@salesforce/b2c-tooling-sdk/operations/cap';

// Validate locally
const result = await validateCap('./my-commerce-app');
if (!result.valid) console.error(result.errors);

// Package for distribution
const pkg = await commerceAppPackage('./my-commerce-app');

// Install on an instance
await commerceAppInstall(instance, './my-commerce-app', { siteId: 'RefArch' });

// Uninstall
await commerceAppUninstall(instance, 'my-app', 'tax', { siteId: 'RefArch' });

Interfaces

Type Aliases

Functions

References

JobExecutionError

Re-exports JobExecutionError