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

@salesforce/b2c-tooling-sdk / config / CreateB2CInstanceOptions

Interface: CreateB2CInstanceOptions ​

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:536

Options for constructing a B2C instance from resolved configuration.

Extends ​

Properties ​

defaultWebDavClient? ​

optional defaultWebDavClient: boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:551

Let WebDAV fall back to a browser login with the built-in public client when neither Basic auth nor an API client is configured. The resulting user token is authorized by the user's Business Manager permissions, so no access key or WebDAV Client Permissions entry is needed. OCAPI and SCAPI are unaffected. Enable it only for WebDAV-only operations (file transfer, logs, code upload), since the login starts on the first WebDAV request.


oauthStrategy? ​

optional oauthStrategy: AuthStrategy | () => AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:542

Pre-resolved OAuth strategy, or a lazy factory for one. CLI command bases use the factory form to preserve stored PKCE sessions and avoid prompting unless an OAuth-backed client is actually used.


openBrowser()? ​

optional openBrowser: (url, login?) => Promise<void>

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:532

Custom browser opener for browser OAuth flows. Receives the authorization URL and, for PKCE logins, a handle to the pending login.

Parameters ​

url ​

string

login? ​

BrowserLogin

Returns ​

Promise<void>

Inherited from ​

CreateOAuthOptions.openBrowser


redirectUri? ​

optional redirectUri: string

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:530

Override redirect URI for browser OAuth flows (e.g., for port forwarding in remote environments)

Inherited from ​

CreateOAuthOptions.redirectUri


webdavFallbackStrategy? ​

optional webdavFallbackStrategy: AuthStrategy | () => AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:557

WebDAV-only fallback strategy (or lazy factory). Takes precedence over defaultWebDavClient; used by callers that build their own browser login strategy.