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

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 →
Skip to content
View as Markdown
View as Markdown

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

Interface: UpdateEnvironmentBackendOptions ​

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

Options for updateEnvironmentWithBackend.

Extends ​

Properties ​

allowCookies? ​

optional allowCookies: boolean | null

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

Forward cookies to origin (legacy only).


enableSourceMaps? ​

optional enableSourceMaps: boolean | null

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

Enable source maps (legacy only).


environment ​

environment: string

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

Environment slug (= SCAPI environment ID) to update.


externalDomain? ​

optional externalDomain: string | null

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

External domain (legacy only).


externalHostname? ​

optional externalHostname: string | null

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

Full external hostname (legacy only).


hostname? ​

optional hostname: string | null

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

Hostname pattern for V8 Tag loading (legacy only).


isProduction? ​

optional isProduction: boolean

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

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" | null

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

Minimum log level (legacy only).


name? ​

optional name: string

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

New display name for the environment (both backends).


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


preserveProxyUserAgent? ​

optional preserveProxyUserAgent: boolean | null

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

Forward the original client User-Agent header to proxy origins (legacy only).


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[] | null

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

Proxy configurations (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


ssrStaticIps? ​

optional ssrStaticIps: boolean

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

Make outbound requests from static IPs (legacy only).


whitelistedIps? ​

optional whitelistedIps: string | null

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

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