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 / project-index / IndexedCustomApiEndpoint

Interface: IndexedCustomApiEndpoint ​

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:155

A Custom API endpoint from rest-apis/<api>/api.json, joined with its schema.yaml operation.

Properties ​

api ​

api: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:156


apiType ​

apiType: "unknown" | "admin" | "shopper"

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:171

shopper (ShopperToken), admin (AmOAuth2), or unknown.


cartridge ​

cartridge: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:159


endpoint ​

endpoint: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:158

Endpoint name in api.json; matches the schema's operationId and the exported function.


implementation? ​

optional implementation: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:161


implementationFile? ​

optional implementationFile: object

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:173

Implementation script relative to the cartridge, and the exported function's line.

line? ​

optional line: number

relPath ​

relPath: string


method? ​

optional method: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:163

HTTP method from schema.yaml (GET).


path? ​

optional path: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:165

Path from schema.yaml (/loyalty-info).


problems ​

problems: string[]

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:177

Problems found while joining api.json, schema.yaml, and the script.


public? ​

optional public: boolean

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:175

Whether the exported function is marked .public = true (required).


schema? ​

optional schema: string

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:160


scopes? ​

optional scopes: string[]

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:169

Scopes required by the security requirement (c_loyalty).


security? ​

optional security: string[]

Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:167

Security schemes that apply (ShopperToken, AmOAuth2).