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

Interface: PushMrtBundleBackendOptions ​

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:972

Options for pushMrtBundle.

Properties ​

buildDirectory? ​

optional buildDirectory: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:992

Build output directory.

configPath? ​

optional configPath: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:998

v2 in-archive config path (v2 uploads only).

legacyAuth? ​

optional legacyAuth: AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:978

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

matchMode? ​

optional matchMode: BundleV2MatchMode

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1000

v2 match mode (v2 uploads only).

message? ​

optional message: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:984

Bundle message/description.

onFallback()? ​

optional onFallback: (reason) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:1011

Invoked when auto falls back from SCAPI to legacy.

Parameters ​

reason ​

string

Returns ​

void

onResolve()? ​

optional onResolve: (backend) => void

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

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

Parameters ​

backend ​

MrtBackend

Returns ​

void

origin? ​

optional origin: string

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

Legacy MRT API origin.

preference ​

preference: MrtBackendPreference

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:974

Resolved --mrt-backend preference.

projectDirectory? ​

optional projectDirectory: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:994

Directory to read config.server.{ts,js} from.

projectSlug ​

projectSlug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:980

Project slug (= SCAPI storefront ID).

rootDir? ​

optional rootDir: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:996

v2 archive root directory (v2 uploads only).

scapiConnection? ​

optional scapiConnection: ScapiMrtConnection

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:976

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

ssrOnly? ​

optional ssrOnly: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:988

Glob patterns for server-only files.

ssrParameters? ​

optional ssrParameters: Record<string, unknown>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:986

SSR runtime parameters.

ssrShared? ​

optional ssrShared: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:990

Glob patterns for files shared between server and client.

targetSlug? ​

optional targetSlug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:982

Target/environment slug (= SCAPI environment ID). When omitted, the bundle is uploaded but not deployed.

v2? ​

optional v2: boolean

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

Use the v2 bundle format/endpoint. SCAPI is always v2 (this flag is redundant there). Legacy defaults to v1; set this to route the legacy push through the v2 endpoint so the rootDir/configPath/matchMode options take effect.