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

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 →
Skip to content
View as Markdown
View as Markdown

b2c_tooling_sdk.operations.catalogs ​

SCAPI-first catalog operations with transitional OCAPI fallback.

Mirrors src/operations/catalogs/index.ts.

Classes ​

CatalogInfo ​

python
class CatalogInfo

Normalized catalog summary, shared by both backends.

Fields

NameTypeDefault
idstr
namestr | NoneNone
onlinebool | NoneNone
rawAnyNone

CatalogsBackend ​

python
class CatalogsBackend(BackendBase, Protocol)

Common interface implemented by both catalogs backends.

list_catalogs method ​

python
async def list_catalogs(options: ListCatalogsOptions | None = None) -> list[CatalogInfo]

List catalogs, paginating internally up to options.count (or all).

ListCatalogsOptions ​

python
class ListCatalogsOptions

Options for CatalogsBackend.list_catalogs.

Fields

NameTypeDefault
startint | NoneNone
countint | NoneNone

OcapiCatalogsBackend ​

python
class OcapiCatalogsBackend

Lists catalogs against the legacy OCAPI Data API /catalogs resource.

Fields

NameType
nameLiteral['ocapi']

ScapiCatalogsBackend ​

python
class ScapiCatalogsBackend

Lists catalogs against the SCAPI Catalogs Admin API.

Fields

NameType
nameLiteral['scapi']

Functions ​

create_catalogs_backend ​

python
def create_catalogs_backend(config: CatalogsBackendConfig) -> CatalogsBackend

Create a CatalogsBackend, resolving SCAPI/OCAPI per config.

Attributes ​

CatalogsBackendConfig ​

python
CatalogsBackendConfig = DualBackendConfig

ScapiCatalogsBackendConfig ​

python
ScapiCatalogsBackendConfig = ScapiBackendCtorConfig