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

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

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 →

View as Markdown

View as Markdown

@salesforce/b2c-tooling-sdk / operations/bm-users / ScapiUsersBackend

Class: ScapiUsersBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:61

Backend contract for BM user operations.

Merchant Users has no server-side search endpoint, so the SCAPI backend implements portable search criteria over its paginated user listing. Raw OCAPI query DSL, access keys, and whoami remain OCAPI-only.

Implements

UsersBackend

Constructors

Constructor

new ScapiUsersBackend(config): ScapiUsersBackend

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:67

Parameters

config

ScapiUsersBackendConfig

Returns

ScapiUsersBackend

Properties

name

readonly name: "scapi"

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:62

Implementation of

UsersBackend.name

Methods

createOrReplaceUser()

createOrReplaceUser(login, input): Promise<UserInfo>

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

Parameters

string

input

CreateUserInput

Returns

Promise<UserInfo>

Implementation of

UsersBackend.createOrReplaceUser

deleteUser()

deleteUser(login): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:221

Parameters

string

Returns

Promise<void>

Implementation of

UsersBackend.deleteUser

getUser()

getUser(login): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:145

Parameters

string

Returns

Promise<UserInfo>

Implementation of

UsersBackend.getUser

listUsers()

listUsers(options): Promise<ListUsersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:77

Parameters

options

ListUsersOptions = {}

Returns

Promise<ListUsersResult>

Implementation of

UsersBackend.listUsers

searchUsers()

searchUsers(options): Promise<ListUsersResult>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:100

Parameters

options

SearchUsersOptions = {}

Returns

Promise<ListUsersResult>

Implementation of

UsersBackend.searchUsers

updateUser()

updateUser(login, changes): Promise<UserInfo>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/scapi-backend.ts:181

Parameters

string

changes

UpdateUserChanges

Returns

Promise<UserInfo>

Implementation of

UsersBackend.updateUser