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 --scope project

Start a new Claude Code session in your project. Use --scope user instead for all projects.

Manual MCP setup

From your project directory:

bash
claude mcp add --transport stdio --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new session. Use --scope user instead for all projects. 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

  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

From your project directory, run:

bash
gemini mcp add --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new Gemini CLI session. Use --scope user instead for all projects. 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/bm-roles / OcapiRolesBackend

Class: OcapiRolesBackend ​

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:152

Common shape of every dual-backend implementation. Each canonical backend (e.g., JobsBackend) extends this so a generic fallback wrapper can read name to know which backend served the last call.

Implements ​

Constructors ​

Constructor ​

new OcapiRolesBackend(instance): OcapiRolesBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:155

Parameters ​

instance ​

B2CInstance

Returns ​

OcapiRolesBackend

Properties ​

name ​

readonly name: "ocapi"

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:153

Implementation of ​

RolesBackend.name

Methods ​

createRole() ​

createRole(roleId, input?): Promise<RoleInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:173

Parameters ​

roleId ​

string

input? ​

CreateRoleInput

Returns ​

Promise<RoleInfo>

Implementation of ​

RolesBackend.createRole

deleteRole() ​

deleteRole(roleId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:178

Parameters ​

roleId ​

string

Returns ​

Promise<void>

Implementation of ​

RolesBackend.deleteRole

getPermissions() ​

getPermissions(roleId): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:182

Parameters ​

roleId ​

string

Returns ​

Promise<{ }>

Implementation of ​

RolesBackend.getPermissions

getRole() ​

getRole(roleId, options?): Promise<RoleInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:168

Parameters ​

roleId ​

string

options? ​
expand? ​

("users" | "permissions")[]

Returns ​

Promise<RoleInfo>

Implementation of ​

RolesBackend.getRole

grantRole() ​

grantRole(roleId, login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:192

Assigns a user to a role. Returns void; OCAPI returns the user but we don't surface that.

Parameters ​

roleId ​

string

login ​

string

Returns ​

Promise<void>

Implementation of ​

RolesBackend.grantRole

listRoles() ​

listRoles(options): Promise<ListRolesResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:157

Parameters ​

options ​

ListRolesOptions = {}

Returns ​

Promise<ListRolesResult>

Implementation of ​

RolesBackend.listRoles

revokeRole() ​

revokeRole(roleId, login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:196

Parameters ​

roleId ​

string

login ​

string

Returns ​

Promise<void>

Implementation of ​

RolesBackend.revokeRole

setPermissions() ​

setPermissions(roleId, permissions): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-roles/ocapi-backend.ts:187

Parameters ​

roleId ​

string

permissions ​

Returns ​

Promise<{ }>

Implementation of ​

RolesBackend.setPermissions