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.

Turn on auto-update

Claude Code does not auto-update third-party marketplaces by default, so installed plugins stay on the version you installed. To get new releases automatically, run /plugin, open Marketplaces, select b2c-developer-tooling, and choose Enable auto-update. Claude Code then checks for updates when a session starts; run /reload-plugins or start a new session to load them.

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 / project-index / BuildProjectIndexOptions

Interface: BuildProjectIndexOptions ​

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:52

Options for buildProjectIndex.

Properties ​

cartridgePath? ​

optional cartridgePath: string[]

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:68

Cartridge path order (names), applied to discovered cartridges.


cartridgePathSource? ​

optional cartridgePathSource: CartridgeOrder

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:73

Where cartridgePath came from, reported as ProjectIndex.cartridgeOrder. Defaults to {source: 'configured'}; pass {source: 'instance', siteId, hostname} for a path read from an instance.


cartridges? ​

optional cartridges: CartridgeLocation[]

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:58

Cartridges to index, in cartridge path order. Overrides discovery.


detectSitePath? ​

optional detectSitePath: boolean

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:79

Without cartridgePath or cartridges, order by a site cartridge path found in the project's site import files (sites/<id>/site.xml, the latest by migration or import set timestamp). Defaults to true.


host? ​

optional host: CartridgeFileSystemHost

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:82


includeAllCartridges? ​

optional includeAllCartridges: boolean

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:64

Index every cartridge in the project, not just those on the cartridge path: path cartridges first in path order, then the rest in discovery order (as if the site ran them all). notOnPath is still reported. Defaults to false.


otherCartridges? ​

optional otherCartridges: CartridgeLocation[]

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:66

With cartridges: cartridges in the project that aren't on the path, reported as ProjectIndex.otherCartridges.


paths? ​

optional paths: string[]

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:56

Additional directories to search for cartridges.


root? ​

optional root: string

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:54

Directory to search for cartridges when cartridges is not given. Defaults to the current directory.


siteId? ​

optional siteId: string

Defined in: packages/b2c-tooling-sdk/src/project-index/build.ts:81

Site whose site.xml cartridge path to use; defaults to the best match.