Skip to content

Commit 99f9700

Browse files
committed
update setup instruction and remove unneeded scripts
1 parent 9ce3356 commit 99f9700

2 files changed

Lines changed: 9 additions & 29 deletions

File tree

packages/b2c-dx-mcp/README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -185,59 +185,41 @@ For CLI-based testing:
185185

186186
```bash
187187
# List all tools
188-
npx mcp-inspector --cli node bin/run.js --toolsets all --allow-non-ga-tools --method tools/list
188+
npx mcp-inspector --cli node bin/dev.js --toolsets all --allow-non-ga-tools --method tools/list
189189

190190
# Call a specific tool
191-
npx mcp-inspector --cli node bin/run.js --toolsets all --allow-non-ga-tools \
191+
npx mcp-inspector --cli node bin/dev.js --toolsets all --allow-non-ga-tools \
192192
--method tools/call \
193193
--tool-name sfnext_design_decorator
194194
```
195195

196-
#### 2. IDE Integration (Recommended)
196+
#### 2. IDE Integration
197197

198-
For local development with IDE integration (e.g., Cursor, VS Code), use the **watch mode workflow**. This provides fast iteration without requiring global dependencies.
199-
200-
**Step 1: Start TypeScript in watch mode**
201-
202-
In a terminal, run:
203-
204-
```bash
205-
cd packages/b2c-dx-mcp
206-
pnpm run dev:watch
207-
```
208-
209-
This watches for file changes and recompiles automatically (~1-2 seconds per change).
210-
211-
**Step 2: Configure your IDE to use the production build**
212-
213-
Add this to your IDE's MCP configuration:
198+
Configure your IDE to use the local MCP server. Add this to your IDE's MCP configuration:
214199

215200
```json
216201
{
217202
"mcpServers": {
218203
"b2c-dx-local": {
219204
"command": "node",
220-
"args": ["/full/path/to/packages/b2c-dx-mcp/bin/run.js", "--toolsets", "all", "--allow-non-ga-tools"]
205+
"args": ["/full/path/to/packages/b2c-dx-mcp/bin/dev.js", "--toolsets", "all", "--allow-non-ga-tools"]
221206
}
222207
}
223208
}
224209
```
225210

226-
**Development workflow:**
227-
1. Edit source code
228-
2. TypeScript auto-compiles (watch the terminal for confirmation)
229-
3. Restart the MCP server in your IDE to pick up changes
211+
> **Note:** Restart the MCP server in your IDE to pick up code changes.
230212
231213
#### 3. JSON-RPC via stdin
232214

233215
Send raw MCP protocol messages:
234216

235217
```bash
236218
# List all tools (--allow-non-ga-tools required for placeholder tools)
237-
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node bin/run.js --toolsets all --allow-non-ga-tools
219+
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node bin/dev.js --toolsets all --allow-non-ga-tools
238220

239221
# Call a specific tool
240-
echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"cartridge_deploy","arguments":{}}}' | node bin/run.js --toolsets all --allow-non-ga-tools
222+
echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"cartridge_deploy","arguments":{}}}' | node bin/dev.js --toolsets all --allow-non-ga-tools
241223
```
242224

243225
### Configuration

packages/b2c-dx-mcp/package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,11 @@
6060
},
6161
"scripts": {
6262
"build": "tsc",
63-
"dev:watch": "tsc --watch",
6463
"clean": "shx rm -rf dist",
6564
"lint": "eslint",
6665
"format": "prettier --write src",
6766
"format:check": "prettier --check src",
68-
"preinspect": "pnpm run build",
69-
"inspect": "mcp-inspector node bin/run.js --toolsets all --allow-non-ga-tools",
67+
"inspect": "mcp-inspector node bin/dev.js --toolsets all --allow-non-ga-tools",
7068
"pretest": "tsc --noEmit -p test",
7169
"test": "mocha --forbid-only \"test/**/*.test.ts\"",
7270
"posttest": "pnpm run lint",

0 commit comments

Comments
 (0)