Skip to content

Commit 55d65d7

Browse files
authored
Update README with correct instructions (#6)
* Update Readme with correct instructions * Remove $ in codeblock instructions
1 parent 7a4f552 commit 55d65d7

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,27 @@ An MCP server that gives Claude Code access to NodeJS at runtime to help you deb
77
1. Add to Claude Code:
88

99
```sh
10-
$ claude mcp add nodejs-debugger npx mcp-nodejs-debugger
10+
claude mcp add nodejs-debugger npx @hyperdrive-eng/mcp-nodejs-debugger
1111
```
1212

1313
1. Start Claude Code
1414

1515
```sh
1616
claude
17-
╭────────────────────────────────────────────────────────────────────────────────
18-
│ ✻ Welcome to Claude Code research preview!
19-
20-
│ /help for help
21-
22-
│ Found 1 MCP server (use /mcp for status)
23-
╰────────────────────────────────────────────────────────────────────────────────
17+
╭───────────────────────────────────────────────────────╮
18+
│ ✻ Welcome to Claude Code research preview!
19+
│ │
20+
│ /help for help
21+
│ │
22+
│ Found 1 MCP server (use /mcp for status) │
23+
╰───────────────────────────────────────────────────────╯
2424
```
2525

2626
2. Run a NodeJS server in [debug mode](https://nodejs.org/en/learn/getting-started/debugging) (i.e. with the `--inspect` flat)
2727

2828
```sh
2929
# In another terminal
30-
$ node --inspect {your_file.js}
30+
node --inspect {your_file.js}
3131
```
3232

3333
3. Ask Claude Code to debug your NodeJS server at runtime
@@ -40,12 +40,35 @@ An MCP server that gives Claude Code access to NodeJS at runtime to help you deb
4040
Please help me debug this error at runtime using the nodejs-debugger mcp.
4141
```
4242
43+
## Usage
44+
45+
1. Add to Claude Code:
46+
47+
```sh
48+
claude mcp add nodejs-debugger npx mcp-nodejs-debugger
49+
```
50+
51+
1. Verify connection
52+
53+
```sh
54+
> /mcp
55+
⎿ MCP Server Status
56+
57+
• nodejs-debugger: connected
58+
```
59+
60+
1. Remove from Claude Code:
61+
62+
```sh
63+
claude remove nodejs-debugger
64+
```
65+
4366
## Example
4467
4568
1. Here is a buggy NodeJS server:
4669
4770
```
48-
$ node --inspect index.js
71+
node --inspect index.js
4972
5073
Debugger listening on ws://127.0.0.1:9229/2862f5a2-8618-4516-8429-1248b397e9b4
5174
@@ -142,27 +165,4 @@ An MCP server that gives Claude Code access to NodeJS at runtime to help you deb
142165
- Update the connection string with real credentials
143166
144167
Which option would you like to proceed with?
145-
```
146-
147-
## Usage
148-
149-
1. Add to Claude Code:
150-
151-
```sh
152-
claude mcp add nodejs-debugger npx mcp-nodejs-debugger
153-
```
154-
155-
1. Verify connection
156-
157-
```sh
158-
> /mcp
159-
⎿ MCP Server Status
160-
161-
• nodejs-debugger: connected
162-
```
163-
164-
1. Remove from Claude Code:
165-
166-
```sh
167-
claude remove nodejs-debugger
168-
```
168+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hyperdrive-eng/mcp-nodejs-debugger",
3-
"version": "0.2.0",
3+
"version": "0.2.1",
44
"description": "An MCP server to debug Node.js at runtime",
55
"main": "index.js",
66
"bin": "./index.js",

0 commit comments

Comments
 (0)