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

@salesforce/b2c-tooling-sdk / docs / DocEntry

Interface: DocEntry

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:58

A documentation entry in the search index.

Entries span multiple corpora (Script API reference, job steps, Developer Center guides, and this project's own docs). Reference entries are bundled on disk and read via DocEntry.filePath; guide entries are indexed locally but their full content is fetched on demand from DocEntry.url.

Properties

category?

optional category: DocCategory

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:68

The corpus/category this entry belongs to.


filePath?

optional filePath: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:74

Path of the bundled markdown file relative to its corpus data directory. Present for entries whose content ships in the package; absent for entries whose content is fetched online (see DocEntry.sourceUrl).


headings?

optional headings: string

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

Section headings joined into a single searchable string (indexed, not for display).


id

id: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:64

Unique identifier. For bundled reference this is the filename without its extension (e.g., "dw.catalog.ProductMgr"); for guides it is namespaced by category to avoid cross-corpus collisions (e.g., "sfnext/sfnext-get-started").


keywords?

optional keywords: string[]

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:95

Search keywords/synonyms an agent or developer might use to find this doc.


preview?

optional preview: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:104

Optional preview/excerpt from the document.


relatedEntries?

optional relatedEntries: string[]

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:102

IDs of directly related documentation entries. Salesforce Help landing articles use this for linked child topics, while Developer Center guides use it for immediate parent and child pages from the published TOC. Callers can pass any id directly to docs read / docs_read.


sourceUrl?

optional sourceUrl: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:89

The raw-markdown (.md) URL for the same document — the machine-readable source. For online-only entries (guides) this is what readEntryContent fetches at read time. Bundled corpora (Script API, tooling) also carry it so callers can retrieve the raw source on request even though content ships in the package. Absent for corpora with no public page (job steps).


summary?

optional summary: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:93

One-line summary describing what task/topic the doc helps with (agent triage).


title

title: string

Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:66

The title from the document's first heading (e.g., "Class ProductMgr").


url?

optional url: string

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

Canonical human-facing published URL (the rendered .html page, e.g. on developer.salesforce.com). This is the durable link to cite/open in a browser. Present for every corpus that has a public page (guides, Script API reference, tooling); absent for corpora with no public page (job steps).