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/mrt / ListRedirectsBackendOptions

Interface: ListRedirectsBackendOptions ​

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:998

Options for listRedirectsWithBackend.

Extends ​

Properties ​

environment ​

environment: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:937

Target/environment slug (= SCAPI environment ID).

Inherited from ​

RedirectBackendOptions.environment

legacyAuth? ​

optional legacyAuth: AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:933

Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.

Inherited from ​

RedirectBackendOptions.legacyAuth

limit? ​

optional limit: number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1000

Maximum number of results to return (forwarded to both backends).

offset? ​

optional offset: number

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1002

Pagination offset (forwarded to both backends).

onFallback()? ​

optional onFallback: (reason) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:941

Invoked when auto falls back from SCAPI to legacy.

Parameters ​

reason ​

string

Returns ​

void

Inherited from ​

RedirectBackendOptions.onFallback

onResolve()? ​

optional onResolve: (backend) => void

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:943

Invoked with the backend that serves the call (for -D debug).

Parameters ​

backend ​

MrtBackend

Returns ​

void

Inherited from ​

RedirectBackendOptions.onResolve

origin? ​

optional origin: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:939

Legacy MRT API origin.

Inherited from ​

RedirectBackendOptions.origin

preference ​

preference: MrtBackendPreference

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:929

Resolved --mrt-backend preference.

Inherited from ​

RedirectBackendOptions.preference

projectSlug ​

projectSlug: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:935

Project slug (= SCAPI storefront ID).

Inherited from ​

RedirectBackendOptions.projectSlug

scapiConnection? ​

optional scapiConnection: ScapiMrtConnection

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:931

SCAPI connection; when absent, auto uses legacy and scapi throws.

Inherited from ​

RedirectBackendOptions.scapiConnection

optional search: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/redirect.ts:1008

Case-insensitive substring filter on the redirect source path. Honored by the legacy backend only; the SCAPI gateway does not yet accept a search query parameter, so it is ignored there (the caller is warned).