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

Interface: PushV2Options ​

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

Options for pushing a v2-format bundle to MRT.

Extends ​

Properties ​

buildDirectory? ​

optional buildDirectory: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:519

Path to the build directory containing the application build output.

Default ​

ts
'build'

Inherited from ​

CreateBundleV2Options.buildDirectory


bundleMetadata? ​

optional bundleMetadata: BundleV2Metadata

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:513

Bundle metadata written into the config file (dependencies, ccOverrides).

Inherited from ​

CreateBundleV2Options.bundleMetadata


configPath? ​

optional configPath: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:540

Path to the in-archive config file, relative to rootDir.

Default ​

ts
'.mrt/config.json'

Inherited from ​

CreateBundleV2Options.configPath


matchMode? ​

optional matchMode: BundleV2MatchMode

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:546

How the server handles ssrOnly/ssrShared patterns that match no files.

Default ​

ts
'strict'

Inherited from ​

CreateBundleV2Options.matchMode


message? ​

optional message: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:481

Optional message describing the bundle. Defaults to a git-based message or a timestamp.

Inherited from ​

CreateBundleV2Options.message


origin? ​

optional origin: string

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

MRT API origin URL.

Default ​

ts
"https://cloud.mobify.com"

projectDirectory? ​

optional projectDirectory: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:528

Directory to read config.server.{ts,js} from when there is no on-disk v2 config file and ssrOnly/ssrShared are not provided explicitly. The config is read straight from source at bundle time (no build step) and its values are written into the bundle's in-archive config file.

Default ​

ts
process.cwd()

Inherited from ​

CreateBundleV2Options.projectDirectory


projectSlug ​

projectSlug: string

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

The project slug to upload to.


rootDir? ​

optional rootDir: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:534

Archive path prefix under which built files and the config file live.

Default ​

ts
'bld'

Inherited from ​

CreateBundleV2Options.rootDir


ssrOnly? ​

optional ssrOnly: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:498

Glob patterns for files that should only run on the server. Written verbatim into the config file; matched server-side against paths relative to rootDir. If omitted, read from the on-disk v2 config file ({buildDirectory}/{configPath}) if present, else the project's config.server.{ts,js}, else defaults.

Inherited from ​

CreateBundleV2Options.ssrOnly


ssrParameters? ​

optional ssrParameters: Record<string, unknown>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:488

SSR parameters written into the in-archive config file. Merged over defaults and any values from the on-disk v2 config file ({buildDirectory}/{configPath}) or the project's config.server.{ts,js}.

Inherited from ​

CreateBundleV2Options.ssrParameters


ssrShared? ​

optional ssrShared: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:508

Glob patterns for files shared between client and server. Written verbatim into the config file; matched server-side against paths relative to rootDir. If omitted, read from the on-disk v2 config file ({buildDirectory}/{configPath}) if present, else the project's config.server.{ts,js}, else defaults.

Inherited from ​

CreateBundleV2Options.ssrShared