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 / openshell / ApplyOpenShellSetupOptions

Interface: ApplyOpenShellSetupOptions ​

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:234

Options for applyOpenShellSetup.

Extends ​

Properties ​

build? ​

optional build: boolean

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:238

Build the image when it is missing (default true)


dockerfile ​

dockerfile: string

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:83

Dockerfile content used when the image must be built

Inherited from ​

OpenShellApplyOptions.dockerfile


image ​

image: string

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:81

Container image for the sandbox

Inherited from ​

OpenShellApplyOptions.image


onEnvironmentChanged()? ​

optional onEnvironmentChanged: (names) => void

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:250

Called when an existing sandbox is updated but its environment variables (such as SFCC_SAFETY_LEVEL) differ from the setup. They apply only when the sandbox is recreated.

Parameters ​

names ​

string[]

Returns ​

void


onStep()? ​

optional onStep: (step) => void

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:244

Called before each step runs

Parameters ​

step ​

OpenShellStep

Returns ​

void


recreate? ​

optional recreate: boolean

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:242

Delete and recreate an existing sandbox (to apply provider or environment changes)


run? ​

optional run: CommandRunner

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:252

Command runner (for testing)


sandbox? ​

optional sandbox: boolean

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:240

Create the sandbox, or update the policy of an existing one (default true)


secrets ​

secrets: Record<string, string | undefined>

Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:236

Secret values keyed by environment variable name (e.g. SFCC_CLIENT_SECRET)