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/jobs / SystemJobSpec

Interface: SystemJobSpec ​

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:77

Declarative description of a system job to run. The operation supplies its job ID and the two request-body forms; this module drives the rest.

Properties ​

body ​

body: Record<string, unknown>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:87

System-job configuration sent on both APIs (e.g. {file_name}, {export_file, data_units}, or the CAP {app_name, ...} shape). These system jobs retain snake_case fields on SCAPI. When the instance rejects it with UnknownPropertyException, the OCAPI path retries with parameters.

deprecatedScopes? ​

optional deprecatedScopes: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:94

Scopes named in the OCAPI-deprecation error (the rw jobs scope).

failVerb ​

failVerb: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:100

Human-readable verb for error messages, e.g. 'execute import job'.

jobId ​

jobId: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:79

System job ID, e.g. sfcc-site-archive-import.

parameters ​

parameters: object[]

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:92

Job parameters ([{name, value}]) for the OCAPI internal-user retry. System jobs do not use the generic SCAPI JobExecutionRequest body.

name ​

name: string

value ​

value: string

wait? ​

optional wait: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:96

Whether to wait for completion (default true).

waitOptions? ​

optional waitOptions: WaitForJobOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:98

Wait options forwarded to the poll loop.