Skip to content

Commit 9af16c5

Browse files
docs(README): add Cursor demo and instructions (#9)
* docs(README): add Cursor demo * docs(README): adds cropped Cursor demo
1 parent 6825cfb commit 9af16c5

File tree

1 file changed

+103
-13
lines changed

1 file changed

+103
-13
lines changed

README.md

Lines changed: 103 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,49 @@
1-
# MCP NodeJS Debugger
1+
# MCP Node.js Debugger
22

3-
An MCP server that gives Claude Code access to NodeJS at runtime to help you debug: [`mcp-nodejs-debugger`](https://www.npmjs.com/package/mcp-nodejs-debugger).
3+
An MCP server that gives Cursor or Claude Code access to Node.js at runtime to help you debug: [`@hyperdrive-eng/mcp-nodejs-debugger`](https://www.npmjs.com/package/@hyperdrive-eng/mcp-nodejs-debugger).
44

55
## Demo
66

7+
### Cursor
8+
9+
https://github.com/user-attachments/assets/c193a17e-b0e6-4c51-82aa-7f3f0de17e1a
10+
11+
### Claude Code
712

813
https://github.com/user-attachments/assets/adb7321b-3a6a-459b-a5c9-df365710d4d8
914

15+
## Quick start
16+
17+
### Cursor
1018

19+
1. Add to Cursor (`~/.cursor/mcp.json`)
1120

12-
## Get started
21+
![image](https://github.com/user-attachments/assets/132092ab-52d9-4790-84bb-9e9702603390)
22+
23+
```diff
24+
+ {
25+
+ "mcpServers": {
26+
+ "nodejs-debugger": {
27+
+ "command": "npx",
28+
+ "args": ["@hyperdrive-eng/mcp-nodejs-debugger"]
29+
+ }
30+
+ }
31+
+ }
32+
```
1333

14-
1. Add to Claude Code:
34+
1. Run a Node.js server in [debug mode](https://nodejs.org/en/learn/getting-started/debugging) (i.e. with the `--inspect` flat)
35+
36+
```sh
37+
node --inspect {file.js}
38+
```
39+
40+
1. Ask Cursor to debug your Node.js server at runtime
41+
42+
![image](https://github.com/user-attachments/assets/fa85982b-33ce-41df-ac90-58ce6a73c433)
43+
44+
### Claude Code
45+
46+
1. Add to Claude Code
1547

1648
```sh
1749
claude mcp add nodejs-debugger npx @hyperdrive-eng/mcp-nodejs-debugger
@@ -30,26 +62,28 @@ https://github.com/user-attachments/assets/adb7321b-3a6a-459b-a5c9-df365710d4d8
3062
╰───────────────────────────────────────────────────────╯
3163
```
3264

33-
2. Run a NodeJS server in [debug mode](https://nodejs.org/en/learn/getting-started/debugging) (i.e. with the `--inspect` flat)
65+
2. Run a Node.js server in [debug mode](https://nodejs.org/en/learn/getting-started/debugging) (i.e. with the `--inspect` flat)
3466

3567
```sh
3668
# In another terminal
37-
node --inspect {your_file.js}
69+
node --inspect {file.js}
3870
```
3971

40-
3. Ask Claude Code to debug your NodeJS server at runtime
72+
3. Ask Claude Code to debug your Node.js server at runtime
4173

4274
```sh
43-
> I'm getting a runtime error in NodeJS.
75+
> I'm getting a runtime error in Node.js
4476

4577
{YOUR_RUNTIME_ERROR}
4678

4779
Please help me debug this error at runtime using the nodejs-debugger mcp.
4880
```
49-
81+
5082
## Usage
5183

52-
1. Add to Claude Code:
84+
### Claude Code
85+
86+
1. Add to Claude Code
5387

5488
```sh
5589
claude mcp add nodejs-debugger npx mcp-nodejs-debugger
@@ -64,15 +98,71 @@ https://github.com/user-attachments/assets/adb7321b-3a6a-459b-a5c9-df365710d4d8
6498
• nodejs-debugger: connected
6599
```
66100

67-
1. Remove from Claude Code:
101+
1. Remove from Claude Code
68102

69103
```sh
70104
claude remove nodejs-debugger
71105
```
72106

107+
### Cursor
108+
109+
1. Add to Cursor (`~/.cursor/mcp.json`)
110+
111+
```diff
112+
+ {
113+
+ "mcpServers": {
114+
+ "nodejs-debugger": {
115+
+ "command": "npx",
116+
+ "args": ["@hyperdrive-eng/mcp-nodejs-debugger"]
117+
+ }
118+
+ }
119+
+ }
120+
```
121+
122+
1. Verify connection:
123+
124+
![image](https://github.com/user-attachments/assets/132092ab-52d9-4790-84bb-9e9702603390)
125+
126+
1. Remove from Cursor (`~/.cursor/mcp.json`):
127+
128+
```diff
129+
- {
130+
- "mcpServers": {
131+
- "nodejs-debugger": {
132+
- "command": "npx",
133+
- "args": ["@hyperdrive-eng/mcp-nodejs-debugger"]
134+
- }
135+
- }
136+
- }
137+
```
138+
73139
## Example
74140

75-
1. Here is a buggy NodeJS server:
141+
### Cursor
142+
143+
1. Run this simple Node.js app: [github.com/mdn/express-locallibrary-tutorial](https://github.com/mdn/express-locallibrary-tutorial):
144+
145+
```sh
146+
node --inspect ./bin/www
147+
```
148+
149+
1. Ask Cursor to set a breakpoint
150+
151+
![image](https://github.com/user-attachments/assets/fa85982b-33ce-41df-ac90-58ce6a73c433)
152+
153+
![image](https://github.com/user-attachments/assets/d24b3423-b7c3-4268-ab86-732371aa047c)
154+
155+
2. Create a book at [`localhost:3000/catalog/book/create`](http://localhost:3000/catalog/book/create)
156+
157+
![image](https://github.com/user-attachments/assets/165cb026-7767-417d-a52e-2423e5e5728e)
158+
159+
1. Watch Cursor capture runtime state
160+
161+
![image](https://github.com/user-attachments/assets/a7204504-7441-4592-9758-0397086ba724)
162+
163+
### Claude Code
164+
165+
1. Here is a buggy Node.js server:
76166

77167
```
78168
node --inspect index.js
@@ -107,7 +197,7 @@ https://github.com/user-attachments/assets/adb7321b-3a6a-459b-a5c9-df365710d4d8
107197
}
108198
```
109199

110-
1. Claude Code debugs the NodeJS server at runtime:
200+
1. Claude Code debugs the Node.js server at runtime:
111201

112202
```sh
113203
> I'm getting a runtime error connecting to mongoose. Please help me debug by checking the value of

0 commit comments

Comments
 (0)