Skip to content

@W-20590941 Updates for local dev process #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yhsieh1 merged 5 commits into from
Dec 29, 2025
Merged

@W-20590941 Updates for local dev process #18

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ce3356
@W-20590941 updates for local dev process
yhsieh1 Dec 29, 2025
99f9700
update setup instruction and remove unneeded scripts
yhsieh1 Dec 29, 2025
9cca885
Update packages/b2c-dx-mcp/README.md
yhsieh1 Dec 29, 2025
7c57038
update script
yhsieh1 Dec 29, 2025
11ba888
Merge branch 't/commerce/W-20590941/updates' of https://github.com/Sa…
yhsieh1 Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions packages/b2c-dx-mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,37 +193,40 @@ npx mcp-inspector --cli node bin/run.js --toolsets all --allow-non-ga-tools \
--tool-name sfnext_design_decorator
```

#### 2. IDE Integration
#### 2. IDE Integration (Recommended)

Configure your IDE to use the local server. Choose development mode (no build required) or production mode (requires build).
For local development with IDE integration (e.g., Cursor, VS Code), use the **watch mode workflow**. This provides fast iteration without requiring global dependencies.

**Development Mode** (recommended for active development - uses TypeScript source directly):
**Step 1: Start TypeScript in watch mode**

```json
{
"mcpServers": {
"b2c-dx-local": {
"command": "/full/path/to/packages/b2c-dx-mcp/bin/dev.js",
"args": ["--toolsets", "all", "--allow-non-ga-tools"]
}
}
}
In a terminal, run:

```bash
cd packages/b2c-dx-mcp
pnpm run dev:watch
```

**Production Mode** (uses compiled JavaScript - run `pnpm run build` first):
This watches for file changes and recompiles automatically (~1-2 seconds per change).

**Step 2: Configure your IDE to use the production build**

Add this to your IDE's MCP configuration:

```json
{
"mcpServers": {
"b2c-dx-local": {
"command": "/full/path/to/packages/b2c-dx-mcp/bin/run.js",
"args": ["--toolsets", "all", "--allow-non-ga-tools"]
"command": "node",
"args": ["/full/path/to/packages/b2c-dx-mcp/bin/run.js", "--toolsets", "all", "--allow-non-ga-tools"]
}
}
}
```

> **Note:** For production mode, run `pnpm run build` after code changes and restart your IDE. Development mode picks up changes automatically.
**Development workflow:**
1. Edit source code
2. TypeScript auto-compiles (watch the terminal for confirmation)
3. Restart the MCP server in your IDE to pick up changes

#### 3. JSON-RPC via stdin

Expand Down
1 change: 1 addition & 0 deletions packages/b2c-dx-mcp/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
},
"scripts": {
"build": "tsc",
"dev:watch": "tsc --watch",
"clean": "shx rm -rf dist",
"lint": "eslint",
"format": "prettier --write src",
Expand Down
Loading