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 / operations/object-types / ObjectTypesClient

Class: ObjectTypesClient ​

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:100

Operations over the SCAPI Object Definitions API: system object types, attribute definitions, and attribute groups.

List methods page through all results. Attribute IDs may be passed with or without the c_ prefix.

Example ​

ts
const ot = new ObjectTypesClient(instance.scapiClientConfig!);
const attrs = await ot.listAttributeDefinitions('Product', {kind: 'custom'});

Constructors ​

Constructor ​

new ObjectTypesClient(config): ObjectTypesClient

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

Parameters ​

config ​

ObjectTypesConfig

Returns ​

ObjectTypesClient

Properties ​

client ​

readonly client: ObjectDefinitionsClient

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:101


organizationId ​

readonly organizationId: string

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

Methods ​

assignAttributeToGroup() ​

assignAttributeToGroup(objectType, groupId, attributeId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:110

Assigns an attribute definition to a group.

Parameters ​

objectType ​

string

groupId ​

string

attributeId ​

string

Returns ​

Promise<void>


createOrReplaceAttributeDefinition() ​

createOrReplaceAttributeDefinition(objectType, definition): Promise<{ created: boolean; definition: { }; }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:128

Creates or fully replaces an attribute definition. Properties omitted from definition are reset to their defaults; use updateAttributeDefinition for partial changes.

Parameters ​

objectType ​

string

definition ​

Returns ​

Promise<{ created: boolean; definition: { }; }>


createOrReplaceAttributeGroup() ​

createOrReplaceAttributeGroup(objectType, group): Promise<{ created: boolean; group: { }; }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:145

Creates or fully replaces an attribute group. Replacing a group removes its attribute assignments.

Parameters ​

objectType ​

string

group ​

Returns ​

Promise<{ created: boolean; group: { }; }>


deleteAttributeDefinition() ​

deleteAttributeDefinition(objectType, attributeId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:159

Deletes a custom attribute definition.

Parameters ​

objectType ​

string

attributeId ​

string

Returns ​

Promise<void>


deleteAttributeGroup() ​

deleteAttributeGroup(objectType, groupId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:169

Deletes an attribute group.

Parameters ​

objectType ​

string

groupId ​

string

Returns ​

Promise<void>


getAttributeDefinition() ​

getAttributeDefinition(objectType, attributeId, options): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:183

Gets one attribute definition. With includeValues, uses the search endpoint so enum valueDefinitions are returned (requires .rw scope).

Parameters ​

objectType ​

string

attributeId ​

string

options ​
includeValues? ​

boolean

Returns ​

Promise<{ }>


getAttributeGroup() ​

getAttributeGroup(objectType, groupId, options): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:205

Gets one attribute group, optionally with its assigned definitions.

Parameters ​

objectType ​

string

groupId ​

string

options ​

ListAttributeGroupsOptions = {}

Returns ​

Promise<{ }>


getObjectType() ​

getObjectType(objectType): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:225

Gets one system object type with its attribute and group counts.

Parameters ​

objectType ​

string

Returns ​

Promise<{ }>


listAttributeDefinitions() ​

listAttributeDefinitions(objectType, options): Promise<object[]>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:239

Lists attribute definitions of an object type. Filtering and enum values go through the search endpoint (requires .rw scope); a plain listing uses the list endpoint and works with the read-only scope.

Parameters ​

objectType ​

string

options ​

ListAttributeDefinitionsOptions = {}

Returns ​

Promise<object[]>


listAttributeGroups() ​

listAttributeGroups(objectType, options): Promise<object[]>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:257

Lists attribute groups of an object type.

Parameters ​

objectType ​

string

options ​

ListAttributeGroupsOptions = {}

Returns ​

Promise<object[]>


listObjectTypes() ​

listObjectTypes(): Promise<object[]>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:281

Lists system object types. Custom object types are not addressable by this API; they appear as unnamed CustomObject entries and are omitted.

Returns ​

Promise<object[]>


searchAttributeDefinitions() ​

searchAttributeDefinitions(objectType, query): Promise<object[]>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:292

Runs an attribute definition search and returns all hits (requires .rw scope).

Parameters ​

objectType ​

string

query ​

Returns ​

Promise<object[]>


unassignAttributeFromGroup() ​

unassignAttributeFromGroup(objectType, groupId, attributeId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:306

Removes an attribute definition from a group.

Parameters ​

objectType ​

string

groupId ​

string

attributeId ​

string

Returns ​

Promise<void>


updateAttributeDefinition() ​

updateAttributeDefinition(objectType, attributeId, changes): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:323

Partially updates an attribute definition. valueType cannot be changed, and enum values (valueDefinitions) are ignored by the API.

Parameters ​

objectType ​

string

attributeId ​

string

changes ​

Partial<ObjectAttributeDefinition>

Returns ​

Promise<{ }>


updateAttributeGroup() ​

updateAttributeGroup(objectType, groupId, changes): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:338

Partially updates an attribute group.

Parameters ​

objectType ​

string

groupId ​

string

changes ​

Partial<ObjectAttributeGroup>

Returns ​

Promise<{ }>