Skip to content

Commit 5154424

Browse files
committed
update readme
1 parent b527db0 commit 5154424

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

packages/b2c-dx-mcp/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,29 @@ npm install -g @salesforce/b2c-dx-mcp
1414

1515
## Configuration
1616

17-
The server needs B2C Commerce credentials, provided via **environment variables** or a **`dw.json` file**.
17+
Tools that interact with B2C Commerce instances (e.g., MRT, SCAPI, cartridge deployment) require credentials, which can be provided via **environment variables**, a **`.env` file**, a **`dw.json` file**, or the **`--config`** flag. Local tools (e.g., scaffolding, development guidelines) work without configuration.
18+
19+
**Priority order** (highest to lowest):
20+
1. Environment variables (`SFCC_*`) — includes `.env` file if present (shell env vars override `.env`)
21+
2. `dw.json` file (auto-discovered or via `--config`)
1822

1923
### Option 1: Environment Variables
2024

25+
Set environment variables directly or create a `.env` file in your project root:
26+
2127
```bash
22-
export SFCC_HOSTNAME="your-sandbox.demandware.net"
23-
export SFCC_USERNAME="your.username"
24-
export SFCC_PASSWORD="your-access-key"
25-
export SFCC_CLIENT_ID="your-client-id"
26-
export SFCC_CLIENT_SECRET="your-client-secret"
27-
export SFCC_CODE_VERSION="version1"
28+
# .env file or shell exports
29+
SFCC_HOSTNAME="your-sandbox.demandware.net"
30+
SFCC_USERNAME="your.username"
31+
SFCC_PASSWORD="your-access-key"
32+
SFCC_CLIENT_ID="your-client-id"
33+
SFCC_CLIENT_SECRET="your-client-secret"
34+
SFCC_CODE_VERSION="version1"
2835
```
2936

3037
### Option 2: dw.json File
3138

32-
Create a `dw.json` file (auto-discovered from current directory):
39+
Create a `dw.json` file in your project root (auto-discovered by searching upward from current working directory):
3340

3441
```json
3542
{
@@ -205,7 +212,7 @@ Or use pnpm's filter flag from the monorepo root:
205212
pnpm --filter @salesforce/b2c-dx-mcp run <script>
206213
```
207214

208-
### Testing the MCP Server
215+
### Testing the MCP Server Locally
209216

210217
#### 1. MCP Inspector
211218

0 commit comments

Comments
 (0)