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

Interface: UpdateProjectBackendOptions ​

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1003

Options for updateProjectWithBackend.

Extends ​

Properties ​

allowCookies? ​

optional allowCookies: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1019

Whether cookies are allowed (SCAPI only).


legacyAuth? ​

optional legacyAuth: AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:797

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

Inherited from ​

ProjectBackendOptions.legacyAuth


name? ​

optional name: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1007

New name (legacy only; SCAPI cannot rename a storefront).


onFallback()? ​

optional onFallback: (reason) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:801

Invoked when auto falls back from SCAPI to legacy.

Parameters ​

reason ​

string

Returns ​

void

Inherited from ​

ProjectBackendOptions.onFallback


onResolve()? ​

optional onResolve: (backend) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:803

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

Parameters ​

backend ​

MrtBackend

Returns ​

void

Inherited from ​

ProjectBackendOptions.onResolve


origin? ​

optional origin: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:799

Legacy MRT API origin.

Inherited from ​

ProjectBackendOptions.origin


preference ​

preference: MrtBackendPreference

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:793

Resolved --mrt-backend preference.

Inherited from ​

ProjectBackendOptions.preference


preserveProxyUserAgent? ​

optional preserveProxyUserAgent: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1021

Whether the end-user User-Agent is preserved through proxies (SCAPI only).


projectSlug ​

projectSlug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1005

Project slug (= SCAPI storefront ID) to update.


scapiConnection? ​

optional scapiConnection: ScapiMrtConnection

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:795

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

Inherited from ​

ProjectBackendOptions.scapiConnection


sites? ​

optional sites: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1015

Complete replacement set of assigned site IDs (SCAPI only).


ssrArchitecture? ​

optional ssrArchitecture: "x86" | "arm64" | null

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1017

New default SSR architecture (SCAPI only); null clears the default.


ssrRegion? ​

optional ssrRegion: "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/project.ts:1011

New default SSR region, hyphenated legacy form (both backends).


staticIpsDefault? ​

optional staticIpsDefault: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1013

New default static-IP setting for new environments (legacy only).


url? ​

optional url: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1009

New URL (legacy only).