Install AI Tools

B2C Commerce tools, documentation, and skills for your assistant.

Claude

Install the plugin Recommended

bash
claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
claude plugin install b2c-dx-mcp@b2c-developer-tooling --scope project

Start a new Claude Code session in your project. Use --scope user instead for all projects.

Manual MCP setup

From your project directory:

bash
claude mcp add --transport stdio --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new session. Use --scope user instead for all projects. See Claude Code MCP setup.

Claude Desktop setup

Codex

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. This setup also works with the Codex IDE extension and the ChatGPT Work desktop app.

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.

ChatGPT online setup

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

From your project directory, run:

bash
gemini mcp add --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new Gemini CLI session. Use --scope user instead for all projects. 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 / WaitForDeploymentScapiOptions

Interface: WaitForDeploymentScapiOptions ​

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:491

Options for waitForDeploymentScapi.

Properties ​

deploymentId ​

deploymentId: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:495

Deployment UUID returned by createDeploymentScapi.

environmentId ​

environmentId: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:493

now()? ​

optional now: () => number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:511

Custom clock for testing. Defaults to Date.now.

Returns ​

number

onPoll()? ​

optional onPoll: (info) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:507

Optional callback invoked on each poll with current status.

Parameters ​

info ​

DeploymentScapiPollInfo

Returns ​

void

pollIntervalSeconds? ​

optional pollIntervalSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:500

Polling interval in seconds.

Default ​

ts
30

sleep()? ​

optional sleep: (ms) => Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:509

Custom sleep function for testing.

Parameters ​

ms ​

number

Returns ​

Promise<void>

storefrontId ​

storefrontId: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:492

timeoutSeconds? ​

optional timeoutSeconds: number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/deployment.ts:505

Maximum time to wait in seconds (0 for no timeout).

Default ​

ts
600