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

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

MCP Tools

Use B2C Commerce documentation, deployment, debugging, and API tools from your assistant. The plugin installation includes all toolsets; connected capabilities use your existing B2C configuration.

These tables list tool names for reference and for your client's tool controls. Optional toolset customization is covered at the end of this page.

Documentation and skills

Find answers across Salesforce B2C Commerce references and guides from your assistant.

Look up Script API behavior, storefront patterns, API setup, standard job steps, and XML import/export formats. Salesforce Help adds Business Manager guidance for administrators and merchants: jobs, replication, access, catalogs, pricing, promotions, search, and content. Ask for an explanation applied to your task and links to the source documentation.

Included in every toolset. No B2C Commerce credentials required.

ToolCapability
skills_readFind development, operations, CLI, Storefront Next, and MCP workflow skills.
docs_searchFind platform references, guides, Salesforce Help, and tooling docs.
docs_readRead a documentation article.
docs_listBrowse documentation categories and titles.
docs_schema_searchFind XML import/export schemas.
docs_schema_readRead an XML schema.
docs_schema_listList available XML schemas.

The included skill collections complement documentation with development patterns and operational workflows. No separate skills installation is needed.

Example prompt

Check this catalog import XML against the B2C Commerce schema and documented import behavior. Explain what would be replaced or preserved before I run the import, and link to the references.

Documentation search is also available through the B2C CLI. See documentation topic settings to customize coverage.

Deployment

ToolCapabilityToolsets
cartridge_deployUpload cartridges or selected files to a code version; optionally activate/reload it.CARTRIDGES
mrt_bundle_pushPublish a pre-built storefront bundle; optionally deploy it.MRT, PWAV3, STOREFRONTNEXT

Cartridges require WebDAV write access. Code-version discovery and reload use SCAPI (sfcc.scripts / sfcc.scripts.rw) with OCAPI compatibility where available. Check deployment permissions before connecting.

Managed Runtime

Bundle publishing requires an MRT API key and project, plus an environment when deploying.

Instance files

Browse instance directories, read exact job logs, and upload or download files without installing the CLI separately. Upload text directly or transfer files from the machine running the MCP server.

ToolCapabilityToolsets
webdav_listList a directory with file sizes and modification dates.CARTRIDGES, DIAGNOSTICS, SCAPI
webdav_getRead part of a text file or download a whole file.CARTRIDGES, DIAGNOSTICS, SCAPI
webdav_putUpload text or a local file; replace existing files only when requested.CARTRIDGES, SCAPI

Requires WebDAV access to the selected directory. Whole-file transfers are limited to 64 MiB. Upload folders must already exist; local downloads require a new filename. Selected cartridge uploads support up to 100 files / 64 MiB total. See file access.

Example prompt

Download the log for this failed job execution and identify the first error. Don't rerun the job.

Debugging

Let your assistant investigate what happens inside a running cartridge. It can pause at a breakpoint, inspect the call stack and variable values, and step through controllers, hooks, jobs, and custom API code to explain unexpected behavior.

Available in DIAGNOSTICS, CARTRIDGES, and SCAPI. Requires a Business Manager user or access key with WebDAV_Manage_Customization; OAuth is unsupported.

ToolCapability
debug_start_sessionConnect the debugger and map local cartridge sources.
debug_end_sessionDisconnect and release the debugger slot.
debug_list_sessionsFind active sessions, breakpoints, and paused threads.
debug_set_breakpointsSet or clear breakpoints.
debug_wait_for_stopWait for execution to pause.
debug_controlContinue execution or step into, over, or out of a function.
debug_inspectInspect stacks, frame variables, and object members.
debug_evaluateEvaluate JavaScript in a paused frame.
debug_capture_at_breakpointCapture debugger state at a selected line.

Breakpoints pause requests; evaluation can change application state. Use a sandbox and end sessions when finished. See debugger access.

Example prompt

Pause at this line in my sandbox while I reproduce the request. Show which branch ran and the relevant variable values, then resume and disconnect. Don't modify the code.

See debugging with an assistant or IDE.

Logs

ToolCapabilityToolsets
logs_list_filesBrowse instance log files.DIAGNOSTICS, CARTRIDGES, SCAPI
logs_get_recentRead and filter recent instance logs.DIAGNOSTICS, CARTRIDGES, SCAPI
logs_watchStart, list, or stop instance log watches.DIAGNOSTICS, CARTRIDGES, SCAPI
logs_watch_pollRetrieve entries from an instance log watch.DIAGNOSTICS, CARTRIDGES, SCAPI
mrt_logs_watchStart, list, or stop live MRT log streams.DIAGNOSTICS, PWAV3, STOREFRONTNEXT
mrt_logs_watch_pollRetrieve entries from an MRT log stream.DIAGNOSTICS, PWAV3, STOREFRONTNEXT

Instance logs require WebDAV log-read access. MRT logs require an API key, project, and environment; historical MRT logs are not available. Logs may contain sensitive data; see data handling.

Example prompt

Watch my sandbox error logs while I reproduce this issue. Summarize new errors and include the timestamps.

SCAPI development

Available in SCAPI, PWAV3, and STOREFRONTNEXT. Requires OAuth, the instance short code, and tenant ID. See authentication and scopes.

ToolCapabilityOAuth scope
scapi_schemas_listBrowse and read standard and custom API schemas.sfcc.scapi-schemas
scapi_custom_apis_get_statusCheck custom endpoint registration.sfcc.custom-apis

B2C Commerce data and operations

Explore nearly 600 Salesforce Commerce API operations and work with your instance's data.

Explore products, catalogs, orders, customers, inventory, pricing, and more. SCAPI code mode lets your assistant work across APIs in a single task: create a product and assign it to a category, review a campaign's promotions, or investigate failed jobs. Describe the outcome you want in your own words.

Available in SCAPI, PWAV3, and STOREFRONTNEXT.

ToolCapability
scapi_searchFind Admin and Shopper API operations and their requirements.
scapi_executeRead and manage B2C Commerce data through standard and custom Admin APIs.
scapi_snippet_saveSave a workflow for reuse across sessions.

The standard API reference works offline without credentials. Working with your instance's data requires OAuth credentials and scopes for the requested operations. Your account permissions and configured Safety Mode control access, including creating, updating, and deleting records.

Custom attributes and custom Admin APIs are supported. Discovering your instance's custom definitions requires the sfcc.scapi-schemas scope; custom APIs also require their declared scopes. See code mode access.

Current limits: Shopper APIs are available for reference only. Code mode does not yet run Shopper API requests or upload and download binary files.

Example prompt

Create an offline test product in my catalog, check that its ID is unused, and verify the saved product.

Ready-to-use workflows cover product creation and category assignment, campaign reviews, job history and step inspection, code-version checks, and site cartridge path checks. Products created with the built-in workflow start offline unless you request otherwise.

ChatGPT creating an offline test product after checking its ID is unused, then verifying the saved product and its storefront catalog category assignment.

Example prompt

Show failed job executions from the past week. Summarize the first three failures and tell me whether there are more to investigate.

Example prompt

Summarize the promotions attached to this campaign, including enabled status and schedules.

Ask your assistant to save a useful workflow so you can repeat it for other products, campaigns, or dates. Saved workflows remain available across sessions and use the credentials and safety settings of the project where you run them.

Observability metrics (closed beta)

metrics_get reads B2C Commerce metrics. Available in SCAPI; requires tenant access to the Metrics API closed beta and OAuth scope sfcc.metrics.

Analytics reports

Turn B2C Commerce analytics into answers for your site.

Compare sales and average order value, find searches with no results, review promotions and payment methods, or identify slow and failing APIs. CIP/CCAC reports give your assistant a starting point; custom analysis supports questions that go beyond them. No separate CLI or SQL client is needed.

Example prompt

Which SCAPI endpoints had the highest 5xx error rates last week? Include request volume so I can distinguish recurring problems from isolated failures.

ToolCapability
cip_discoverFind reports, inspect their inputs and SQL, or browse available tables and columns.
cip_queryRun sales, merchandising, and technical reports or custom SQL analyses.

Available in CIP, included in the default installation. Requires Account Manager client credentials and the Salesforce Commerce API role for the selected tenant. Production and non-production availability, host selection, and setup are covered in the analytics guide.

Results contain up to 500 rows and may be limited further by response size. Use CLI exports for larger local datasets. Keep queries focused on a chosen period; long-running analyses may time out. Analytics can lag storefront activity; use logs or live APIs for immediate state. See analytics access.

Configuration inspection

ToolCapabilityToolsets
config_inspectCheck resolved configuration and targets; secrets are masked by default.DIAGNOSTICS, CIP

Toolsets for customization

ToolsetCapabilities
CARTRIDGESCartridge deployment and instance diagnostics.
DIAGNOSTICSDebugging, instance/MRT logs, and configuration inspection.
MRTManaged Runtime bundle publishing and deployment.
PWAV3Shared MRT and SCAPI tools for PWA Kit projects.
SCAPIAPI development, instance diagnostics, and optional metrics.
STOREFRONTNEXTShared MRT and SCAPI tools for Storefront Next projects.
CIPAnalytics report discovery, warehouse metadata, and SQL queries.

Skills and documentation are included in every toolset. Shared tools appear once.