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.

Turn on auto-update

Claude Code does not auto-update third-party marketplaces by default, so installed plugins stay on the version you installed. To get new releases automatically, run /plugin, open Marketplaces, select b2c-developer-tooling, and choose Enable auto-update. Claude Code then checks for updates when a session starts; run /reload-plugins or start a new session to load them.

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 / auth / PkceOAuthConfig

Interface: PkceOAuthConfig ​

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:108

Configuration for the OAuth Authorization Code + PKCE flow.

Extends ​

Properties ​

accountManagerHost? ​

optional accountManagerHost: string

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:111


authorize()? ​

optional authorize: (url, context) => Promise<string | URL>

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:130

Deliver the authorization redirect yourself instead of the SDK's loopback server. Called with the authorize URL; resolve with the full redirect URL (<redirectUri>?code=...&state=...) once Account Manager redirects, or reject to cancel. When set, no local listener is opened and openBrowser and localPort are ignored. The SDK still checks state and performs the PKCE token exchange.

Use this in hosts that can intercept the redirect themselves, such as an Electron BrowserWindow watching will-redirect. redirectUri may be any URI registered for the client, including an app scheme (myapp://callback).

Parameters ​

url ​

string

context ​
redirectUri ​

string

Returns ​

Promise<string | URL>


clientId ​

clientId: string

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:109


forceRefresh? ​

optional forceRefresh: boolean

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:159

Renew a stored sign-in with its refresh token even when the access token is still valid, so it gets a new expiry (used by b2c auth login). Falls back to the browser flow when there is no refresh token or renewal fails.


interactive? ​

optional interactive: boolean

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:140

Whether the strategy may start an interactive sign-in. Defaults to true.

When false, the strategy uses only the cached or stored session and its refresh token. If neither yields an access token it throws AuthRequiredError instead of opening a browser, so the host decides when to ask the user to sign in again. Call PkceOAuthStrategy.signIn to sign in explicitly.


localPort? ​

optional localPort: number

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:113

Local port for the redirect server (default 8080 or SFCC_OAUTH_LOCAL_PORT).


openBrowser()? ​

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

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:117

Custom browser opener. Receives the authorization URL and a handle to cancel the pending login.

Parameters ​

url ​

string

login? ​

BrowserLogin

Returns ​

Promise<void>


persistSession? ​

optional persistSession: boolean

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:153

Persist tokens (access + refresh) to disk between CLI invocations, keyed by clientId. When a refresh token is available it is used to silently obtain a new access token instead of opening the browser. Defaults to true.


redirectUri? ​

optional redirectUri: string

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:115

Override redirect URI (default http://localhost:${localPort} or SFCC_REDIRECT_URI).


scopes? ​

optional scopes: string[]

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:110


sessionBackend? ​

optional sessionBackend: AuthSessionBackend

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-pkce.ts:146

Session store for this strategy. Defaults to the process-wide backend (see setAuthSessionBackend), which is a JSON file in the CLI data directory unless a host installs another backend.