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/mrt / MrtProjectView

Interface: MrtProjectView ​

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:529

An MRT project (= SCAPI storefront), normalized across the legacy and SCAPI backends so the CLI renders one shape regardless of backend.

Fields that only one backend reports are optional: url/organization are legacy-only, sites/architecture are SCAPI-only. Region and status strings are kept in each backend's own form (legacy ssr_region/deletion_status, SCAPI ssrRegion/setupStatus) so display doesn't silently change for existing legacy users.

Properties ​

architecture? ​

optional architecture: string | null

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:541

Default SSR architecture (SCAPI only), when reported.


backend ​

backend: MrtBackend

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:555

Backend that produced this row.


createdAt? ​

optional createdAt: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:549

Creation timestamp (ISO 8601), when present.


id ​

id: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:531

Project slug (= SCAPI storefront ID).


name ​

name: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:533

Project / storefront name.


organization? ​

optional organization: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:545

Owning organization slug (legacy only).


region? ​

optional region: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:539

Default SSR region, in the backend's own form, when reported.


sites? ​

optional sites: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:547

Assigned site IDs (SCAPI only).


staticIpsDefault? ​

optional staticIpsDefault: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:553

Whether new environments get static outbound IPs by default (legacy only).


status? ​

optional status: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:537

Lifecycle status (legacy deletion_status, SCAPI setupStatus), when reported.


type? ​

optional type: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:535

Project type (legacy project_type, SCAPI type), when reported.


updatedAt? ​

optional updatedAt: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:551

Last-modified timestamp (ISO 8601), when present.


url? ​

optional url: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:543

Project URL (legacy only).