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

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/mrt / CreateEnvironmentBackendOptions

Interface: CreateEnvironmentBackendOptions

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

Options for createEnvironmentWithBackend.

Extends

EnvBackendOptions

Properties

allowCookies?

optional allowCookies: boolean

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

Forward cookies to origin (legacy only).

enableSourceMaps?

optional enableSourceMaps: boolean

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

Enable source maps (legacy only).

externalDomain?

optional externalDomain: string

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

External domain (legacy only).

externalHostname?

optional externalHostname: string

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

Full external hostname (legacy only).

hostname?

optional hostname: string

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

Hostname pattern for V8 Tag loading (legacy only).

isProduction?

optional isProduction: boolean

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

Mark as a production 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

logLevel?

optional logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"

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

Minimum log level (legacy only).

name?

optional name: string

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

Display name for the new environment. SCAPI requires it (the only field it accepts on create); legacy defaults it to the slug. Optional here so each backend branch validates it — SCAPI throws a MrtScapiPreconditionError when absent so auto can fall back to legacy.

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

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

proxyConfigs?

optional proxyConfigs: object[]

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

Proxy configurations (legacy only).

host

host: string

path

path: string

region?

optional region: "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "ap-south-1" | "ap-south-2" | "ap-northeast-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-3" | "ca-central-1" | "eu-central-1" | "eu-central-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-south-1" | "il-central-1" | "me-central-1" | "sa-east-1"

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

Default SSR region, hyphenated legacy form (legacy only).

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:1562

Environment slug (legacy only; SCAPI generates the environment ID).

ssrStaticIps?

optional ssrStaticIps: boolean

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

Make outbound requests from static IPs (legacy only).

whitelistedIps?

optional whitelistedIps: string

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

IP whitelist, space-separated CIDR blocks (legacy only).