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 / SearchBmUsersOptions

Interface: SearchBmUsersOptions

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:93

Options for searching BM users.

Searchable fields per the Data API spec: login, email, first_name, last_name, external_id, last_login_date, is_locked, is_disabled.

Properties

count?

optional count: number

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:116

Number of items to return (default 25)

disabled?

optional disabled: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:108

Match disabled users

email?

optional email: string

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:104

Match users with a specific email

locked?

optional locked: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:106

Match locked users

optional login: string

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:102

Match users with a specific login

query?

optional query: unknown

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:98

Pre-built OCAPI query object (e.g. {text_query: {fields: ['login'], search_phrase: 'foo'}}). If omitted, one is built from the convenience flags below.

searchPhrase?

optional searchPhrase: string

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

Free-text phrase searched across login/email/first_name/last_name

select?

optional select: string

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:118

Property selector (default returns shallow user fields)

sortBy?

optional sortBy: string

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:110

Field to sort by (e.g. 'login', 'email', 'last_login_date')

sortOrder?

optional sortOrder: "asc" | "desc"

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:112

Sort direction

start?

optional start: number

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:114

Start index (default 0)