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 / docs / SearchDocsOptions

Interface: SearchDocsOptions ​

Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:294

Options for searchDocs.

Properties ​

category? ​

optional category: DocCategory | DocCategory[]

Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:298

Restrict results to one or more corpora/categories (hard filter).


enabledCategories? ​

optional enabledCategories: readonly DocCategory[]

Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:317

A hard allowlist of categories that bounds the ENTIRE available corpus for this call — a configuration boundary, distinct from the per-query SearchDocsOptions.category filter and the soft workspace boost.

When set, only entries in these categories are ever eligible; any category narrows within this set (their intersection wins). Intended to be resolved once from a launch-time flag/env var (see resolveEnabledCategories) so operators can pin the docs surface to exactly the topics they want exposed. undefined means no restriction.


limit? ​

optional limit: number

Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:296

Maximum number of results to return (default: 20).


workspace? ​

optional workspace: ProjectType | ProjectType[]

Defined in: packages/b2c-tooling-sdk/src/docs/search.ts:305

The current workspace marker(s) (e.g. from workspace detection). When set, the categories relevant to those markers rank higher (always a boost — never hides anything). To hard-scope instead, use SearchDocsOptions.category or SearchDocsOptions.enabledCategories.