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

  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

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 →
Agentic B2C Developer Toolkit

Appearance

View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / operations/cip / CipReportParamDefinition

Interface: CipReportParamDefinition ​

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:15

Parameter contract for a curated CIP report.

Properties ​

default? ​

optional default: string

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:39

Default value applied when the parameter is omitted. For multiple parameters this may be a comma-separated string. Defaults are injected before validation so a report can rely on the value being present.

description ​

description: string

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:17

max? ​

optional max: number

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:21

min? ​

optional min: number

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:20

multiple? ​

optional multiple: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:33

When true, the parameter accepts multiple comma-separated values, suitable for a SQL IN (...) clause. Each value is validated against options when both are set.

name ​

name: string

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:16

options? ​

optional options: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:27

Allowed values for an enum-style parameter (for example ['4xx', '5xx']). When set, CipReportParamType should be string and the value is validated against this set before the report's SQL builder runs.

required? ​

optional required: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:19

type ​

type: CipReportParamType

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:18