Install AI Tools

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

Claude

Using Claude Desktop? See Claude Desktop (Cowork) setup.

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.

Codex/ChatGPT

Using the ChatGPT desktop app (ChatGPT Work)? See ChatGPT Work setup.

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. Codex plugins also work in ChatGPT Work.

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.

VS Code

Install in VS Code

Install the plugin Recommended

  1. Open the Command Palette (Cmd/Ctrl+Shift+P) and run Chat: Install Plugin from Source.
  2. Enter SalesforceCommerceCloud/b2c-developer-tooling.
  3. Select b2c-dx-mcp and follow the installation prompts.
  4. 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 →
Agentic B2C Developer Toolkit

Appearance

View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / operations/mrt / CloneEnvironmentBackendOptions

Interface: CloneEnvironmentBackendOptions ​

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1673

Options for cloneEnvironmentWithBackend.

Extends ​

Properties ​

certificateId? ​

optional certificateId: number | null

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1691

Certificate ID to associate with the new environment (legacy only).

cloneB2cTargetInfo? ​

optional cloneB2cTargetInfo: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1685

Clone B2C target info from the source environment.

cloneEnvironmentVariables? ​

optional cloneEnvironmentVariables: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1683

Clone environment variables from the source environment.

cloneRedirects? ​

optional cloneRedirects: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1681

Clone redirects from the source environment.

displayName? ​

optional displayName: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1677

Display name for the new environment (SCAPI only; required there).

externalDomain? ​

optional externalDomain: string | null

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1689

External domain for the new environment (legacy only).

externalHostname? ​

optional externalHostname: string | null

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1687

Full external hostname for the new environment (legacy only).

legacyAuth? ​

optional legacyAuth: AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1450

Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.

Inherited from ​

EnvBackendOptions.legacyAuth

onFallback()? ​

optional onFallback: (reason) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1456

Invoked when auto falls back from SCAPI to legacy.

Parameters ​

reason ​

string

Returns ​

void

Inherited from ​

EnvBackendOptions.onFallback

onResolve()? ​

optional onResolve: (backend) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1458

Invoked with the backend that serves the call (for -D debug).

Parameters ​

backend ​

MrtBackend

Returns ​

void

Inherited from ​

EnvBackendOptions.onResolve

origin? ​

optional origin: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1454

Legacy MRT API origin.

Inherited from ​

EnvBackendOptions.origin

preference ​

preference: MrtBackendPreference

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1446

Resolved --mrt-backend preference.

Inherited from ​

EnvBackendOptions.preference

projectSlug ​

projectSlug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1452

Project slug (= SCAPI storefront ID).

Inherited from ​

EnvBackendOptions.projectSlug

scapiConnection? ​

optional scapiConnection: ScapiMrtConnection

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1448

SCAPI connection; when absent, auto uses legacy and scapi throws.

Inherited from ​

EnvBackendOptions.scapiConnection

slug? ​

optional slug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1675

Slug for the new environment (legacy only; SCAPI generates the environment ID).

sourceEnvironment ​

sourceEnvironment: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1679

Slug of the source environment to clone from (both backends).