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

Interface: PushOptions ​

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

Options for pushing a bundle to MRT.

Extends ​

Properties ​

buildDirectory? ​

optional buildDirectory: string

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

Path to the build directory containing the application build output.

Default ​

ts
'build'

Inherited from ​

CreateBundleOptions.buildDirectory


message? ​

optional message: string

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

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

Inherited from ​

CreateBundleOptions.message


origin? ​

optional origin: string

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

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

Directory to read config.server.{ts,js} from when ssrOnly/ssrShared are not provided explicitly. The config is read straight from source at bundle time (no build step), so config.server.js need not be emitted into the build output.

Default ​

ts
process.cwd()

Inherited from ​

CreateBundleOptions.projectDirectory


projectSlug ​

projectSlug: string

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

Project slug for the MRT project. Used to prefix files in the archive.

Inherited from ​

CreateBundleOptions.projectSlug


ssrOnly? ​

optional ssrOnly: string[]

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

Glob patterns for files that should only run on the server. If omitted, loaded from config.server.{ts,js} in the project directory (or the legacy build/config.server.js) if present.

Example ​

ts
['ssr.js', 'ssr/*.js']

Inherited from ​

CreateBundleOptions.ssrOnly


ssrParameters? ​

optional ssrParameters: Record<string, unknown>

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

SSR parameters to include in the bundle. These are configuration values for the SSR runtime.

Inherited from ​

CreateBundleOptions.ssrParameters


ssrShared? ​

optional ssrShared: string[]

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

Glob patterns for files shared between client and server. If omitted, loaded from config.server.{ts,js} in the project directory (or the legacy build/config.server.js) if present.

Example ​

ts
['static/**/*', '**/*.js']

Inherited from ​

CreateBundleOptions.ssrShared


target? ​

optional target: string

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

Target environment to deploy to after push. If not provided, bundle is uploaded but not deployed.