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 / operations/logs / TailLogsOptions

Interface: TailLogsOptions ​

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:81

Options for tailing logs.

Extends ​

Properties ​

lastEntries? ​

optional lastEntries: number

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:97

Number of recent entries to show per file on startup. Set to 0 to skip initial entries and only show new ones.

Default ​

ts
1

maxEntries? ​

optional maxEntries: number

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:103

Maximum number of entries to collect before stopping. When set, the tail operation will automatically stop after collecting this many entries. Useful for programmatic access.


onEntry()? ​

optional onEntry: (entry) => void

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:69

Called for each new log entry

Parameters ​

entry ​

LogEntry

Returns ​

void

Inherited from ​

TailLogsCallbacks.onEntry


onError()? ​

optional onError: (error) => void

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:71

Called when an error occurs

Parameters ​

error ​

Error

Returns ​

void

Inherited from ​

TailLogsCallbacks.onError


onFileDiscovered()? ​

optional onFileDiscovered: (file) => void

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:73

Called when a new log file is discovered

Parameters ​

file ​

LogFile

Returns ​

void

Inherited from ​

TailLogsCallbacks.onFileDiscovered


onFileRotated()? ​

optional onFileRotated: (file) => void

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:75

Called when file rotation is detected (file size decreased)

Parameters ​

file ​

LogFile

Returns ​

void

Inherited from ​

TailLogsCallbacks.onFileRotated


pathNormalizer()? ​

optional pathNormalizer: (message) => string

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:108

Path normalizer function to convert remote paths to local paths. Called on each log message to make paths clickable in IDEs.

Parameters ​

message ​

string

Returns ​

string


pollInterval? ​

optional pollInterval: number

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:91

Polling interval in milliseconds.

Default ​

ts
3000

prefixes? ​

optional prefixes: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/logs/types.ts:86

Filter by log prefixes (e.g., ["error", "customerror"]).

Default ​

ts
["error", "customerror"]