Skip to content

Commit f82eaaf

Browse files
@W-20598954 MCP Vuepress docs (#172)
* @W-20598954 MCP Vuepress docs * @W-20598954 MCP docs adjust menu order. integrate auth links * @W-20598954 MCP docs merge into existing guide * @W-20598954 MCP docs edits from knhage * @W-20598954 MCP docs emdash and whitespace fixes * @W-20598954 MCP docs edits from PR reviewers * @W-20598954 MCP docs changeset * @W-20598954 MCP docs B2C Commerce * @W-20598954 MCP docs not a Cloud in the sky * @W-20598954 working directory to project directory rename * @W-20598954 SDK allow deprcated workingDirectory * @W-20598954 revert CI CD working directory change
1 parent 59fdb0f commit f82eaaf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+2125
-242
lines changed

.changeset/many-knives-attend.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@salesforce/b2c-dx-docs': minor
3+
---
4+
5+
Added MCP Server documentation

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Issues labelled `good first contribution`.
4444

4545
# Running the MCP server from source
4646

47-
When developing the B2C DX MCP package (`packages/b2c-dx-mcp`), use `node` with the path to `bin/dev.js` in args. Build to latest (`pnpm run build` from the repo root) so changes that require a rebuild are reflected when you run the server.
47+
For information on running the MCP server from source and local development, see [packages/b2c-dx-mcp/CONTRIBUTING.md](packages/b2c-dx-mcp/CONTRIBUTING.md).
4848

4949
# Contribution Checklist
5050

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
> [!NOTE]
66
> This project is currently in **Developer Preview**. Not all features are implemented, and the API may change in future releases. Please provide feedback via GitHub issues and Unofficial Slack.
77
8-
Salesforce Commerce Cloud B2C Command Line Tools.
8+
Salesforce B2C Commerce Command Line Tools.
99

1010
> [!TIP]
1111
> **Just looking for the B2C CLI or MCP install instructions?** Visit the documentation site at [https://salesforcecommercecloud.github.io/b2c-developer-tooling/](https://salesforcecommercecloud.github.io/b2c-developer-tooling/) for the latest install guide and CLI reference.

docs/.vitepress/config.mts

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,15 @@ const guideSidebar = [
5151
{text: 'Storefront Next', link: '/guide/storefront-next'},
5252
],
5353
},
54+
{
55+
text: 'MCP Server',
56+
items: [
57+
{text: 'Overview', link: '/mcp/'},
58+
{text: 'Installation', link: '/mcp/installation'},
59+
{text: 'Configuration', link: '/mcp/configuration'},
60+
{text: 'Toolsets & Tools', link: '/mcp/toolsets'},
61+
],
62+
},
5463
{
5564
text: 'Extending',
5665
items: [
@@ -83,6 +92,16 @@ const guideSidebar = [
8392
{text: 'Logging', link: '/cli/logging'},
8493
],
8594
},
95+
{
96+
text: 'Tools Reference',
97+
items: [
98+
{text: 'cartridge_deploy', link: '/mcp/tools/cartridge-deploy'},
99+
{text: 'mrt_bundle_push', link: '/mcp/tools/mrt-bundle-push'},
100+
{text: 'scapi_schemas_list', link: '/mcp/tools/scapi-schemas-list'},
101+
{text: 'scapi_custom_apis_status', link: '/mcp/tools/scapi-custom-apis-status'},
102+
{text: 'storefront_next_page_designer_decorator', link: '/mcp/tools/storefront-next-page-designer-decorator'},
103+
],
104+
},
86105
];
87106

88107
// Script to force hard navigation for version switching links
@@ -111,7 +130,7 @@ document.addEventListener('click', (e) => {
111130

112131
export default defineConfig({
113132
title: 'B2C DX',
114-
description: 'Salesforce Commerce Cloud B2C Developer Experience - CLI, MCP Server, and SDK',
133+
description: 'Salesforce B2C Commerce Developer Experience - CLI, MCP Server, and SDK',
115134
base: basePath,
116135

117136
head: [['script', {}, versionSwitchScript]],
@@ -132,6 +151,7 @@ export default defineConfig({
132151
nav: [
133152
{text: 'Guide', link: '/guide/'},
134153
{text: 'CLI Reference', link: '/cli/'},
154+
{text: 'MCP Server', link: '/mcp/'},
135155
{text: 'API Reference', link: '/api/'},
136156
{
137157
text: isDevBuild ? 'Dev' : 'Latest',
@@ -147,6 +167,7 @@ export default defineConfig({
147167
sidebar: {
148168
'/guide/': guideSidebar,
149169
'/cli/': guideSidebar,
170+
'/mcp/': guideSidebar,
150171
'/api/': [
151172
{
152173
text: 'API Reference',

docs/guide/account-manager.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
description: Managing Account Manager users, roles, organizations, and API clients with the B2C CLI including authentication options, CI/CD automation, and common workflows.
2+
description: Manage Account Manager users, roles, organizations, and API clients with the B2C CLI, including authentication options, CI/CD automation, and common workflows.
33
---
44

55
# Account Manager Guide
66

7-
The B2C CLI provides commands for managing Account Manager resourcesusers, roles, organizations, and API clientsdirectly from the terminal. This guide covers authentication setup, common workflows, and CI/CD automation.
7+
The B2C CLI provides commands for managing Account Manager resources—users, roles, organizations, and API clients—directly from the terminal. This guide covers authentication setup, common workflows, and CI/CD automation.
88

99
::: tip
1010
For the full command reference with all flags and options, see [Account Manager Commands](/cli/account-manager).
1111
:::
1212

1313
## Authentication
1414

15-
Account Manager commands work out of the boxno configuration required. The CLI uses a built-in public client that authenticates via browser login. For automation, you can provide your own API client credentials.
15+
Account Manager commands work out of the box—no configuration is required. The CLI uses a built—in public client that authenticates via browser login. For automation, you can provide your own API client credentials.
1616

1717
### Zero-Config (Default)
1818

19-
Just run commands. The CLI opens a browser for login using the built-in client:
19+
Just run the commands without configuring any settings. The CLI opens a browser for login using the built-in client.
2020

2121
```bash
2222
# Works immediately — opens browser for login
@@ -40,7 +40,7 @@ b2c am orgs list --user-auth
4040

4141
### Client Credentials
4242

43-
Uses the API client's secret for non-interactive authentication. Best for CI/CD pipelines, scripts, and automation.
43+
Uses the API client's secret for non-interactive authentication. This option is best for CI/CD pipelines, scripts, and automation.
4444

4545
```bash
4646
# List users with client credentials
@@ -53,11 +53,11 @@ Requirements:
5353

5454
### Authentication Order
5555

56-
By default, the CLI tries client credentials first (if `--client-secret` is provided), then falls back to browser-based user authentication (using either your configured `--client-id` or the built-in public client). To force browser-based login, pass `--user-auth`.
56+
By default, the CLI tries client credentials first (if `--client-secret` is provided), then falls back to browser-based user authentication by using either your configured `--client-id` or the built-in public client. To force browser-based login, pass `--user-auth`.
5757

5858
### Role Requirements
5959

60-
Different operations require different roles, and the required roles depend on how you authenticate:
60+
Different operations require different roles, and the required roles depend on how you authenticate.
6161

6262
| Operations | Client Credentials (roles on API client) | User Auth (roles on user account) |
6363
|---|---|---|
@@ -75,18 +75,18 @@ If authentication fails, the CLI provides contextual error messages recommending
7575

7676
### For Interactive Use
7777

78-
No setup required. Account Manager commands use the CLI's built-in public client by default:
78+
No setup required. Account Manager commands use the CLI's built-in public client by default.
7979

8080
```bash
8181
b2c am users list
8282
```
8383

84-
If you need to use your own API client (for specific scopes or organization restrictions):
84+
If you need to use your own API client for specific scopes or organization restrictions:
8585

86-
1. In [Account Manager](https://account.demandware.com), find or create an API client
87-
2. Under **Redirect URLs**, add `http://localhost:8080`
88-
3. Under **Allowed Scopes**, add: `mail roles tenantFilter openid`
89-
4. Set **Default Scopes** to: `mail roles tenantFilter openid`
86+
1. In [Account Manager](https://account.demandware.com), find or create an API client.
87+
2. Under **Redirect URLs**, add `http://localhost:8080`.
88+
3. Under **Allowed Scopes**, add: `mail roles tenantFilter openid`.
89+
4. Set **Default Scopes** to: `mail roles tenantFilter openid`.
9090

9191
```bash
9292
export SFCC_CLIENT_ID=your-client-id
@@ -95,12 +95,12 @@ b2c am users list --user-auth
9595

9696
### For CI/CD and Automation
9797

98-
1. In [Account Manager](https://account.demandware.com), create a dedicated API client
99-
2. Set a strong password (client secret) and save it securely
100-
3. Set **Token Endpoint Auth Method** to `client_secret_post`
101-
4. Under **Roles**, add **User Administrator** (for user/role management)
102-
5. Under **Allowed Scopes**, add: `mail roles tenantFilter openid`
103-
6. Set **Default Scopes** to: `mail roles tenantFilter openid`
98+
1. In [Account Manager](https://account.demandware.com), create a dedicated API client.
99+
2. Set a strong password (client secret) and save it securely.
100+
3. Set **Token Endpoint Auth Method** to `client_secret_post`.
101+
4. Under **Roles**, add **User Administrator** (for user/role management).
102+
5. Under **Allowed Scopes**, add: `mail roles tenantFilter openid`.
103+
6. Set **Default Scopes** to: `mail roles tenantFilter openid`.
104104

105105
Then configure your CI/CD environment:
106106

@@ -110,7 +110,7 @@ export SFCC_CLIENT_SECRET=your-client-secret
110110
```
111111

112112
::: tip
113-
Store the client secret in your CI/CD system's secrets managernever commit it to source control.
113+
Store the client secret in your CI/CD system's secrets manager—never commit it to source control.
114114
:::
115115

116116
## Common Workflows
@@ -236,7 +236,7 @@ The CLI will suggest the specific role or auth method needed. Common fixes:
236236

237237
### "No valid auth method available"
238238

239-
The CLI could not find credentials for any allowed auth method:
239+
The CLI couldn't find credentials for any allowed auth method:
240240

241241
- Verify `--client-id` is set (or `SFCC_CLIENT_ID` environment variable)
242242
- For client credentials, verify `--client-secret` is set

docs/guide/agent-skills.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ These skills follow the [Agent Skills](https://agentskills.io/home) standard and
1212

1313
When installed, the skills teach AI assistants about B2C Commerce development, CLI commands, and best practices, enabling them to help you with:
1414

15-
- **CLI Operations** - Deploying cartridges, running jobs, managing sandboxes, WebDAV operations
16-
- **B2C Development** - Controllers, ISML templates, forms, localization, logging, metadata
17-
- **Web Services** - HTTP/SOAP/FTP integrations using the Service Framework
18-
- **Custom APIs** - Building SCAPI Custom APIs with contracts, implementations, and mappings
15+
- **CLI Operations**: Deploying cartridges, running jobs, managing sandboxes, WebDAV operations
16+
- **B2C Development**: Controllers, ISML templates, forms, localization, logging, metadata
17+
- **Web Services**: HTTP/SOAP/FTP integrations using the Service Framework
18+
- **Custom APIs**: Building SCAPI Custom APIs with contracts, implementations, and mappings
1919

2020
## Available Plugins
2121

@@ -26,7 +26,7 @@ When installed, the skills teach AI assistants about B2C Commerce development, C
2626

2727
### Plugin: b2c-cli
2828

29-
Skills for using the B2C CLI to manage your Commerce Cloud instances. Covers code deployment, job execution, site archive import/export, WebDAV file operations, On-Demand Sandbox management, and more.
29+
Skills for using the B2C CLI to manage your B2C Commerce instances. Covers code deployment, job execution, site archive import/export, WebDAV file operations, On-Demand Sandbox management, and more.
3030

3131
Browse skills: [skills/b2c-cli/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/skills/b2c-cli/skills)
3232

docs/guide/analytics-reports-cip-ccac.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: User guide for running CIP/CCAC analytics reports and SQL queries w
66

77
The B2C CLI includes a `cip` command family for **B2C Commerce Intelligence (CIP)**, also known as **Commerce Cloud Analytics (CCAC)** reporting.
88

9-
It is based on the **B2C Commerce Intelligence JDBC Driver** and gives you three practical workflows:
9+
It’s based on the **B2C Commerce Intelligence JDBC Driver** and gives you three practical workflows.
1010

11-
- curated report commands (`b2c cip report <report-command>`) for common analytics use cases
12-
- raw SQL (`b2c cip query`) for custom exploration
13-
- metadata discovery (`b2c cip tables`, `b2c cip describe`) for schema/table inspection
11+
- Curated report commands (`b2c cip report <report-command>`) for common analytics use cases
12+
- Raw SQL (`b2c cip query`) for custom exploration
13+
- Metadata discovery (`b2c cip tables`, `b2c cip describe`) for schema/table inspection
1414

1515
Official JDBC reference:
1616

@@ -49,7 +49,7 @@ Starting with B2C Commerce release **26.1**, reports and dashboards data can als
4949
- Staging instances
5050
- Production instances in designated test realms (realms not serving live traffic)
5151

52-
To enable this, turn on **Enable Reports & Dashboards Data Tracking** in Business Manager feature switches.
52+
To enable non-production support, turn on **Enable Reports & Dashboards Data Tracking** in Business Manager feature switches.
5353

5454
- Reference: [Set Feature Switches (Toggles) in B2C Commerce](https://help.salesforce.com/s/articleView?id=cc.b2c_feature_switches.htm&type=5)
5555
- Provisioning can take up to **2 hours** after enabling
@@ -194,10 +194,10 @@ Always check the official documentation before designing high-volume workloads.
194194

195195
Practical guidance:
196196

197-
- prefer aggregate tables over large fact tables when possible
198-
- avoid `SELECT *`; request only required columns
199-
- keep date ranges narrow and run incremental windows
200-
- test with smaller windows first, then scale up
197+
- Prefer aggregate tables over large fact tables when possible.
198+
- Avoid `SELECT *`; request only required columns.
199+
- Keep date ranges narrow and run incremental windows.
200+
- Test with smaller windows first, then scale up.
201201

202202
Reference source for limits and best practices:
203203

docs/guide/authentication.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,17 @@ For Account Manager operations that require user-level roles (organization and A
5353

5454
### Creating an API Client
5555

56-
1. Log in to [Account Manager](https://account.demandware.com)
57-
2. Navigate to **API Client** in the left menu
58-
3. Click **Add API Client**
56+
1. Log in to [Account Manager](https://account.demandware.com).
57+
2. Navigate to **API Client** in the left menu.
58+
3. Click **Add API Client**.
5959
4. Fill in the required fields:
6060
- **Display Name**: A descriptive name (e.g., "B2C CLI")
6161
- **Password**: A strong client secret (save this securely for Client Credentials auth)
6262
5. Configure the **Token Endpoint Auth Method**:
6363
- `client_secret_basic` for client credentials flow
6464

6565
::: warning
66-
The B2C CLI only supports `client_secret_basic` for the Token Endpoint Auth Method. `client_secret_post` and `private_key_jwt` are not currently supported.
66+
The B2C CLI only supports `client_secret_basic` for the Token Endpoint Auth Method. `client_secret_post` and `private_key_jwt` aren't currently supported.
6767
:::
6868

6969
### Assigning Roles
@@ -76,16 +76,16 @@ Most roles require a **tenant filter** that specifies which tenants/realms the r
7676

7777
| Role | Operations | Notes |
7878
| --------------------------------- | ----------------------------------------- | ------------------------------------------- |
79-
| `Salesforce Commerce API` | SCAPI commands and CIP analytics commands | API Clients only. Requires tenant filter. |
79+
| `Salesforce Commerce API` | SCAPI commands and CIP analytics commands | API clients only. Requires a tenant filter. |
8080
| `Sandbox API User` | ODS management, SLAS client management | Requires tenant filter with realm/org IDs. |
81-
| `SLAS Organization Administrator` | SLAS client management (user auth only) | User accounts only. Requires tenant filter. |
81+
| `SLAS Organization Administrator` | SLAS client management (user auth only) | User accounts only. Requires a tenant filter. |
8282

83-
#### For Client Credentials (roles on API Client)
83+
#### For Client Credentials (Roles on API Client)
8484

8585
Under the API Client's **Roles** section:
8686

8787
1. Add roles needed for your operations
88-
2. For each role, configure the **tenant filter** with the tenant IDs (e.g., `zzxy_prd`) or realm IDs you need to access
88+
2. For each role, configure the **tenant filter** with the tenant IDs (for example, `zzxy_prd`) or realm IDs you need to access
8989

9090
**Important:** The `Salesforce Commerce API` role is currently only available for API Clients, not user accounts.
9191

@@ -122,8 +122,8 @@ See the individual CLI command pages for complete scope requirements.
122122
For ODS, SLAS, and SCAPI operations, your API client's roles must have a tenant filter configured:
123123

124124
1. In Account Manager, go to the API Client settings
125-
2. Under each role (e.g., `Salesforce Commerce API`, `Sandbox API User`), find the **Tenant Filter**
126-
3. Add the tenant IDs (e.g., `zzxy_prd`) or organization IDs you need to access
125+
2. Under each role (for example, `Salesforce Commerce API`, `Sandbox API User`), find the **Tenant Filter**
126+
3. Add the tenant IDs (for example, `zzxy_prd`) or organization IDs you need to access
127127

128128
The tenant filter restricts which tenants/realms the role applies to.
129129

@@ -294,7 +294,7 @@ WebDAV is required for file upload operations (`code deploy`, `code watch`, `web
294294

295295
### Option A: Basic Authentication (Recommended)
296296

297-
Use your Business Manager username and a WebDAV access key. This provides better performance for file operations.
297+
Use your Business Manager username and a WebDAV access key. These credentials provide better performance for file operations.
298298

299299
1. In Business Manager, go to **Administration** > **Organization** > **Users**
300300
2. Select your user
@@ -340,7 +340,7 @@ Common paths for CLI operations:
340340
| `/catalogs/<catalog-id>` | Catalog file access |
341341
| `/libraries/<library-id>` | Content library access |
342342

343-
**Note:** This configuration is only needed when using OAuth for WebDAV. It is not required when using basic authentication with username/access key.
343+
**Note:** This configuration is only needed when using OAuth for WebDAV. It isn’t required when using basic authentication with username/access key.
344344

345345
## Managed Runtime API Key
346346

@@ -441,7 +441,7 @@ b2c scapi schemas list
441441

442442
- Add the required scopes to your API client's Default Scopes
443443
- For SCAPI commands, ensure the relevant `sfcc.*` scopes are in Default Scopes
444-
- Verify Default Scopes includes `mail roles tenantFilter openid`
444+
- Verify that Default Scopes includes `mail roles tenantFilter openid`
445445

446446
## Next Steps
447447

docs/guide/ci-cd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CI/CD with GitHub Actions
22

3-
The B2C Developer Tooling project provides official GitHub Actions for automating Commerce Cloud operations in your CI/CD pipelines.
3+
The B2C Developer Tooling project provides official GitHub Actions for automating B2C Commerce operations in your CI/CD pipelines.
44

55
## Overview
66

docs/guide/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ You can configure the CLI using environment variables:
8585

8686
## .env File
8787

88-
The CLI automatically loads a `.env` file from the current working directory if present. Use the same `SFCC_*` variable names as environment variables.
88+
The CLI automatically loads a `.env` file from the current project directory if present. Use the same `SFCC_*` variable names as environment variables.
8989

9090
```bash
9191
# .env

0 commit comments

Comments
 (0)