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 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 / cli / CartridgeDiscoveryOptions

Interface: CartridgeDiscoveryOptions

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:14

Extended options for cartridge discovery that includes instance context.

Extends

FindCartridgesOptions

Properties

codeVersion?

optional codeVersion: string

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:18

Code version being deployed to (if known)

directory

directory: string

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:16

Directory to search for cartridges

exclude?

optional exclude: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:30

Cartridge names to exclude

Inherited from

FindCartridgesOptions.exclude

firstMatchOnly?

optional firstMatchOnly: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:48

When true, stop at the first matching cartridge and return only that one. Useful for existence checks (e.g. workspace-type detection) where the full list is not needed — it lets the underlying scan short-circuit instead of enumerating every .project file. Filters from include/exclude are applied while scanning, so the returned cartridge always satisfies them.

Inherited from

FindCartridgesOptions.firstMatchOnly

include?

optional include: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:28

Cartridge names to include (if empty, all are included)

Inherited from

FindCartridgesOptions.include

instance?

optional instance: B2CInstance

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:20

B2C instance context (if available)

maxDepth?

optional maxDepth: number

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:40

Maximum directory depth to recurse when searching for .project files, counted in path segments relative to the search directory (so a cartridge at cartridges/<name>/.project is depth 3). When omitted the search is unbounded (default), preserving behavior for callers that expect a full recursive walk. Bound this for untrusted/broad roots (e.g. an MCP server that may be launched from a home directory) to avoid scanning the whole filesystem tree.

Inherited from

FindCartridgesOptions.maxDepth