Skip to content

Commit b9440fe

Browse files
W-21260424 Update documentation for mcp config discrepancy (#164)
* W-21260424 Update documentation * Reword readme * Update readme for npx * Update contributing doc for clarity
1 parent c865e2d commit b9440fe

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
4242
If you're new to our project and looking for some way to make your first contribution, look for
4343
Issues labelled `good first contribution`.
4444

45+
# Running the MCP server from source
46+
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.
48+
4549
# Contribution Checklist
4650

4751
- [x] Clean, simple, well styled code

packages/b2c-dx-mcp/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,14 @@ The most important flag is **`--working-directory`** (or env var `SFCC_WORKING_D
2222

2323
> **Important:** MCP clients like Cursor and Claude Desktop spawn servers from the home directory (`~`), not your project. Always set `--working-directory`.
2424
25-
<!-- TODO: Update command to use npx once published to npm -->
26-
2725
**Cursor** (supports `${workspaceFolder}`):
2826

2927
```json
3028
{
3129
"mcpServers": {
3230
"b2c-dx": {
33-
"command": "node",
34-
"args": ["/path/to/packages/b2c-dx-mcp/bin/dev.js", "--working-directory", "${workspaceFolder}", "--allow-non-ga-tools"]
31+
"command": "npx",
32+
"args": ["-y", "@salesforce/b2c-dx-mcp", "--working-directory", "${workspaceFolder}", "--allow-non-ga-tools"]
3533
}
3634
}
3735
}
@@ -43,8 +41,8 @@ The most important flag is **`--working-directory`** (or env var `SFCC_WORKING_D
4341
{
4442
"mcpServers": {
4543
"b2c-dx": {
46-
"command": "node",
47-
"args": ["/path/to/packages/b2c-dx-mcp/bin/dev.js", "--working-directory", "/path/to/your/project", "--allow-non-ga-tools"]
44+
"command": "npx",
45+
"args": ["-y", "@salesforce/b2c-dx-mcp", "--working-directory", "/path/to/your/project", "--allow-non-ga-tools"]
4846
}
4947
}
5048
}

0 commit comments

Comments
 (0)