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

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.

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

Open the Command Palette (Cmd/Ctrl+Shift+P) and run Chat: Install Plugin from Source.
Enter SalesforceCommerceCloud/b2c-developer-tooling.
Select b2c-dx-mcp and follow the installation prompts.
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

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 →

View as Markdown

View as Markdown

@salesforce/b2c-tooling-sdk / operations/jobs / SiteArchiveImportOptions

Interface: SiteArchiveImportOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:32

Options for site archive import.

Properties

keepArchive?

optional keepArchive: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:34

Keep archive on instance after import (default: false)

maxBytes?

optional maxBytes: number

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:58

Optional soft size ceiling (in bytes) for the assembled archive. When set along with SiteArchiveImportOptions.onOversize and the archive exceeds it, the callback is invoked before upload — the import still proceeds. The SDK itself does not warn or block; the consumer decides how to react. Use siteArchiveImportSplit to split oversized imports.

onOversize()?

optional onOversize: (info) => void

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:64

Called before upload when the assembled archive exceeds maxBytes. Lets the consumer (e.g. the CLI) surface its own guidance. Receives the archive size and the configured ceiling.

Parameters

info

bytes

number

maxBytes

number

Returns

void

paths?

optional paths: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:50

Optional list of paths or glob patterns to include in the archive when importing from a directory. Each entry may be:

An absolute path under the root directory
A path relative to the root directory
A glob pattern (relative to the root) — magic chars * ? [ ] { }

When omitted, the entire root directory is archived (current behavior). Entries that resolve outside the root directory throw an error. Ignored when target is a zip file, Buffer, or remote filename.

wait?

optional wait: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:36

Whether to wait for job completion (default: true)

waitOptions?

optional waitOptions: WaitForJobOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:38

Wait options for job completion