@crush-protocol/mcp-client 0.4.10 → 0.4.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -88
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,44 +7,17 @@
|
|
|
7
7
|
|
|
8
8
|
Official MCP client for connecting Cursor, Claude Code, Codex, Gemini CLI, Windsurf, VS Code, and other MCP hosts to Crush.
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
Package name: `@crush-protocol/mcp-client`
|
|
13
|
-
|
|
14
|
-
Treat these names as the same product:
|
|
15
|
-
|
|
16
|
-
- `Crush`
|
|
17
|
-
- `Crush MCP`
|
|
18
|
-
- `Crush Protocol MCP`
|
|
19
|
-
- `@crush-protocol/mcp-client`
|
|
20
|
-
|
|
21
|
-
Recommended flow:
|
|
22
|
-
|
|
23
|
-
```sh
|
|
24
|
-
npx -y @crush-protocol/mcp-client setup --cursor
|
|
25
|
-
npx -y @crush-protocol/mcp-client login
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
If Crush was already installed but is not working:
|
|
29
|
-
|
|
30
|
-
```sh
|
|
31
|
-
npx -y @crush-protocol/mcp-client auth:status
|
|
32
|
-
npx -y @crush-protocol/mcp-client doctor
|
|
33
|
-
```
|
|
10
|
+
<!-- AI Agent Metadata: treat Crush / Crush MCP / Crush Protocol MCP / @crush-protocol/mcp-client as the same product. If tools fail after install, run: auth:status then doctor. -->
|
|
34
11
|
|
|
35
12
|
## Quick Start
|
|
36
13
|
|
|
37
14
|
```sh
|
|
38
|
-
npx -y @crush-protocol/mcp-client setup --cursor
|
|
39
|
-
npx -y @crush-protocol/mcp-client login
|
|
40
|
-
npx -y @crush-protocol/mcp-client ping
|
|
15
|
+
npx -y @crush-protocol/mcp-client setup --cursor # write MCP config
|
|
16
|
+
npx -y @crush-protocol/mcp-client login # OAuth login (one-time)
|
|
17
|
+
npx -y @crush-protocol/mcp-client ping # verify connectivity
|
|
41
18
|
```
|
|
42
19
|
|
|
43
|
-
|
|
44
|
-
2. `login` opens the browser once and stores OAuth credentials locally.
|
|
45
|
-
3. `ping` confirms this machine can reach the hosted Crush MCP.
|
|
46
|
-
|
|
47
|
-
The official hosted Crush MCP URL is built in. End users do not need to paste a server URL.
|
|
20
|
+
The hosted MCP URL is built in — no server URL needed.
|
|
48
21
|
|
|
49
22
|
## What You Can Do
|
|
50
23
|
|
|
@@ -72,8 +45,6 @@ This writes MCP config for all supported hosts at once. To target a single host:
|
|
|
72
45
|
<details>
|
|
73
46
|
<summary><strong>Cursor</strong></summary>
|
|
74
47
|
|
|
75
|
-
[](https://docs.cursor.com/context/model-context-protocol)
|
|
76
|
-
|
|
77
48
|
[](https://cursor.com/install-mcp?name=crush-protocol&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjcnVzaC1wcm90b2NvbC9tY3AtY2xpZW50Il19)
|
|
78
49
|
|
|
79
50
|
```json
|
|
@@ -87,24 +58,24 @@ This writes MCP config for all supported hosts at once. To target a single host:
|
|
|
87
58
|
}
|
|
88
59
|
```
|
|
89
60
|
|
|
61
|
+
[](https://docs.cursor.com/context/model-context-protocol)
|
|
62
|
+
|
|
90
63
|
</details>
|
|
91
64
|
|
|
92
65
|
<details>
|
|
93
66
|
<summary><strong>Claude Code</strong></summary>
|
|
94
67
|
|
|
95
|
-
[](https://docs.anthropic.com/en/docs/claude-code/mcp)
|
|
96
|
-
|
|
97
68
|
```sh
|
|
98
69
|
claude mcp add --scope user crush-protocol -- npx -y @crush-protocol/mcp-client
|
|
99
70
|
```
|
|
100
71
|
|
|
72
|
+
[](https://docs.anthropic.com/en/docs/claude-code/mcp)
|
|
73
|
+
|
|
101
74
|
</details>
|
|
102
75
|
|
|
103
76
|
<details>
|
|
104
77
|
<summary><strong>OpenAI Codex</strong></summary>
|
|
105
78
|
|
|
106
|
-
[](https://developers.openai.com/codex/mcp)
|
|
107
|
-
|
|
108
79
|
**CLI:** `codex mcp add crush-protocol -- npx -y @crush-protocol/mcp-client`
|
|
109
80
|
|
|
110
81
|
**Local** (add to `~/.codex/config.toml`):
|
|
@@ -116,13 +87,13 @@ args = ["-y", "@crush-protocol/mcp-client"]
|
|
|
116
87
|
startup_timeout_ms = 20000
|
|
117
88
|
```
|
|
118
89
|
|
|
90
|
+
[](https://developers.openai.com/codex/mcp)
|
|
91
|
+
|
|
119
92
|
</details>
|
|
120
93
|
|
|
121
94
|
<details>
|
|
122
95
|
<summary><strong>Google Gemini CLI</strong></summary>
|
|
123
96
|
|
|
124
|
-
[](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html)
|
|
125
|
-
|
|
126
97
|
Add to `~/.gemini/settings.json`:
|
|
127
98
|
|
|
128
99
|
```json
|
|
@@ -136,13 +107,13 @@ Add to `~/.gemini/settings.json`:
|
|
|
136
107
|
}
|
|
137
108
|
```
|
|
138
109
|
|
|
110
|
+
[](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html)
|
|
111
|
+
|
|
139
112
|
</details>
|
|
140
113
|
|
|
141
114
|
<details>
|
|
142
115
|
<summary><strong>VS Code</strong></summary>
|
|
143
116
|
|
|
144
|
-
[](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
|
|
145
|
-
|
|
146
117
|
Add to `.vscode/mcp.json`:
|
|
147
118
|
|
|
148
119
|
```json
|
|
@@ -157,13 +128,13 @@ Add to `.vscode/mcp.json`:
|
|
|
157
128
|
}
|
|
158
129
|
```
|
|
159
130
|
|
|
131
|
+
[](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
|
|
132
|
+
|
|
160
133
|
</details>
|
|
161
134
|
|
|
162
135
|
<details>
|
|
163
136
|
<summary><strong>Windsurf</strong></summary>
|
|
164
137
|
|
|
165
|
-
[](https://docs.windsurf.com/windsurf/cascade/mcp)
|
|
166
|
-
|
|
167
138
|
```json
|
|
168
139
|
{
|
|
169
140
|
"mcpServers": {
|
|
@@ -175,13 +146,13 @@ Add to `.vscode/mcp.json`:
|
|
|
175
146
|
}
|
|
176
147
|
```
|
|
177
148
|
|
|
149
|
+
[](https://docs.windsurf.com/windsurf/cascade/mcp)
|
|
150
|
+
|
|
178
151
|
</details>
|
|
179
152
|
|
|
180
153
|
<details>
|
|
181
154
|
<summary><strong>Claude Desktop</strong></summary>
|
|
182
155
|
|
|
183
|
-
[](https://modelcontextprotocol.io/quickstart/user)
|
|
184
|
-
|
|
185
156
|
Edit `claude_desktop_config.json`:
|
|
186
157
|
|
|
187
158
|
```json
|
|
@@ -195,13 +166,13 @@ Edit `claude_desktop_config.json`:
|
|
|
195
166
|
}
|
|
196
167
|
```
|
|
197
168
|
|
|
169
|
+
[](https://modelcontextprotocol.io/quickstart/user)
|
|
170
|
+
|
|
198
171
|
</details>
|
|
199
172
|
|
|
200
173
|
<details>
|
|
201
174
|
<summary><strong>OpenCode</strong></summary>
|
|
202
175
|
|
|
203
|
-
[](https://opencode.ai/docs/mcp-servers)
|
|
204
|
-
|
|
205
176
|
Add to `~/.config/opencode/opencode.json`:
|
|
206
177
|
|
|
207
178
|
```json
|
|
@@ -217,13 +188,13 @@ Add to `~/.config/opencode/opencode.json`:
|
|
|
217
188
|
}
|
|
218
189
|
```
|
|
219
190
|
|
|
191
|
+
[](https://opencode.ai/docs/mcp-servers)
|
|
192
|
+
|
|
220
193
|
</details>
|
|
221
194
|
|
|
222
195
|
<details>
|
|
223
196
|
<summary><strong>Warp</strong></summary>
|
|
224
197
|
|
|
225
|
-
[](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server)
|
|
226
|
-
|
|
227
198
|
```json
|
|
228
199
|
{
|
|
229
200
|
"crush-protocol": {
|
|
@@ -236,13 +207,13 @@ Add to `~/.config/opencode/opencode.json`:
|
|
|
236
207
|
}
|
|
237
208
|
```
|
|
238
209
|
|
|
210
|
+
[](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server)
|
|
211
|
+
|
|
239
212
|
</details>
|
|
240
213
|
|
|
241
214
|
<details>
|
|
242
215
|
<summary><strong>Kiro</strong></summary>
|
|
243
216
|
|
|
244
|
-
[](https://kiro.dev/docs/mcp/configuration/)
|
|
245
|
-
|
|
246
217
|
```json
|
|
247
218
|
{
|
|
248
219
|
"mcpServers": {
|
|
@@ -254,13 +225,13 @@ Add to `~/.config/opencode/opencode.json`:
|
|
|
254
225
|
}
|
|
255
226
|
```
|
|
256
227
|
|
|
228
|
+
[](https://kiro.dev/docs/mcp/configuration/)
|
|
229
|
+
|
|
257
230
|
</details>
|
|
258
231
|
|
|
259
232
|
<details>
|
|
260
233
|
<summary><strong>Roo Code</strong></summary>
|
|
261
234
|
|
|
262
|
-
[](https://docs.roocode.com/features/mcp/using-mcp-in-roo)
|
|
263
|
-
|
|
264
235
|
```json
|
|
265
236
|
{
|
|
266
237
|
"mcpServers": {
|
|
@@ -272,13 +243,13 @@ Add to `~/.config/opencode/opencode.json`:
|
|
|
272
243
|
}
|
|
273
244
|
```
|
|
274
245
|
|
|
246
|
+
[](https://docs.roocode.com/features/mcp/using-mcp-in-roo)
|
|
247
|
+
|
|
275
248
|
</details>
|
|
276
249
|
|
|
277
250
|
<details>
|
|
278
251
|
<summary><strong>Cline</strong></summary>
|
|
279
252
|
|
|
280
|
-
[](https://cline.bot/mcp-marketplace)
|
|
281
|
-
|
|
282
253
|
```json
|
|
283
254
|
{
|
|
284
255
|
"mcpServers": {
|
|
@@ -290,13 +261,13 @@ Add to `~/.config/opencode/opencode.json`:
|
|
|
290
261
|
}
|
|
291
262
|
```
|
|
292
263
|
|
|
264
|
+
[](https://cline.bot/mcp-marketplace)
|
|
265
|
+
|
|
293
266
|
</details>
|
|
294
267
|
|
|
295
268
|
<details>
|
|
296
269
|
<summary><strong>Trae</strong></summary>
|
|
297
270
|
|
|
298
|
-
[](https://docs.trae.ai/ide/model-context-protocol?_lang=en)
|
|
299
|
-
|
|
300
271
|
```json
|
|
301
272
|
{
|
|
302
273
|
"mcpServers": {
|
|
@@ -308,13 +279,13 @@ Add to `~/.config/opencode/opencode.json`:
|
|
|
308
279
|
}
|
|
309
280
|
```
|
|
310
281
|
|
|
282
|
+
[](https://docs.trae.ai/ide/model-context-protocol?_lang=en)
|
|
283
|
+
|
|
311
284
|
</details>
|
|
312
285
|
|
|
313
286
|
<details>
|
|
314
287
|
<summary><strong>Augment Code</strong></summary>
|
|
315
288
|
|
|
316
|
-
[](https://docs.augmentcode.com/)
|
|
317
|
-
|
|
318
289
|
Hamburger menu → Settings → Tools → `+ Add MCP` → Command: `npx -y @crush-protocol/mcp-client`
|
|
319
290
|
|
|
320
291
|
```json
|
|
@@ -329,13 +300,13 @@ Hamburger menu → Settings → Tools → `+ Add MCP` → Command: `npx -y @crus
|
|
|
329
300
|
}
|
|
330
301
|
```
|
|
331
302
|
|
|
303
|
+
[](https://docs.augmentcode.com/)
|
|
304
|
+
|
|
332
305
|
</details>
|
|
333
306
|
|
|
334
307
|
<details>
|
|
335
308
|
<summary><strong>Copilot Coding Agent</strong></summary>
|
|
336
309
|
|
|
337
|
-
[](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp)
|
|
338
|
-
|
|
339
310
|
```json
|
|
340
311
|
{
|
|
341
312
|
"mcpServers": {
|
|
@@ -348,13 +319,13 @@ Hamburger menu → Settings → Tools → `+ Add MCP` → Command: `npx -y @crus
|
|
|
348
319
|
}
|
|
349
320
|
```
|
|
350
321
|
|
|
322
|
+
[](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp)
|
|
323
|
+
|
|
351
324
|
</details>
|
|
352
325
|
|
|
353
326
|
<details>
|
|
354
327
|
<summary><strong>Copilot CLI</strong></summary>
|
|
355
328
|
|
|
356
|
-
[](https://docs.github.com/copilot)
|
|
357
|
-
|
|
358
329
|
Add to `~/.copilot/mcp-config.json`:
|
|
359
330
|
|
|
360
331
|
```json
|
|
@@ -369,13 +340,13 @@ Add to `~/.copilot/mcp-config.json`:
|
|
|
369
340
|
}
|
|
370
341
|
```
|
|
371
342
|
|
|
343
|
+
[](https://docs.github.com/copilot)
|
|
344
|
+
|
|
372
345
|
</details>
|
|
373
346
|
|
|
374
347
|
<details>
|
|
375
348
|
<summary><strong>Amazon Q Developer CLI</strong></summary>
|
|
376
349
|
|
|
377
|
-
[](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html)
|
|
378
|
-
|
|
379
350
|
```json
|
|
380
351
|
{
|
|
381
352
|
"mcpServers": {
|
|
@@ -387,24 +358,24 @@ Add to `~/.copilot/mcp-config.json`:
|
|
|
387
358
|
}
|
|
388
359
|
```
|
|
389
360
|
|
|
361
|
+
[](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html)
|
|
362
|
+
|
|
390
363
|
</details>
|
|
391
364
|
|
|
392
365
|
<details>
|
|
393
366
|
<summary><strong>Amp</strong></summary>
|
|
394
367
|
|
|
395
|
-
[](https://ampcode.com/manual#mcp)
|
|
396
|
-
|
|
397
368
|
```sh
|
|
398
369
|
amp mcp add crush-protocol -- npx -y @crush-protocol/mcp-client
|
|
399
370
|
```
|
|
400
371
|
|
|
372
|
+
[](https://ampcode.com/manual#mcp)
|
|
373
|
+
|
|
401
374
|
</details>
|
|
402
375
|
|
|
403
376
|
<details>
|
|
404
377
|
<summary><strong>Zed</strong></summary>
|
|
405
378
|
|
|
406
|
-
[](https://zed.dev/docs/assistant/context-servers)
|
|
407
|
-
|
|
408
379
|
Add to `settings.json`:
|
|
409
380
|
|
|
410
381
|
```json
|
|
@@ -419,13 +390,13 @@ Add to `settings.json`:
|
|
|
419
390
|
}
|
|
420
391
|
```
|
|
421
392
|
|
|
393
|
+
[](https://zed.dev/docs/assistant/context-servers)
|
|
394
|
+
|
|
422
395
|
</details>
|
|
423
396
|
|
|
424
397
|
<details>
|
|
425
398
|
<summary><strong>JetBrains AI Assistant</strong></summary>
|
|
426
399
|
|
|
427
|
-
[](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html)
|
|
428
|
-
|
|
429
400
|
Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`
|
|
430
401
|
|
|
431
402
|
```json
|
|
@@ -439,13 +410,13 @@ Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`
|
|
|
439
410
|
}
|
|
440
411
|
```
|
|
441
412
|
|
|
413
|
+
[](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html)
|
|
414
|
+
|
|
442
415
|
</details>
|
|
443
416
|
|
|
444
417
|
<details>
|
|
445
418
|
<summary><strong>Qwen Code</strong></summary>
|
|
446
419
|
|
|
447
|
-
[](https://qwenlm.github.io/qwen-code-docs/en/users/features/mcp/)
|
|
448
|
-
|
|
449
420
|
**CLI:** `qwen mcp add crush-protocol npx -y @crush-protocol/mcp-client`
|
|
450
421
|
|
|
451
422
|
```json
|
|
@@ -459,13 +430,13 @@ Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`
|
|
|
459
430
|
}
|
|
460
431
|
```
|
|
461
432
|
|
|
433
|
+
[](https://qwenlm.github.io/qwen-code-docs/en/users/features/mcp/)
|
|
434
|
+
|
|
462
435
|
</details>
|
|
463
436
|
|
|
464
437
|
<details>
|
|
465
438
|
<summary><strong>LM Studio</strong></summary>
|
|
466
439
|
|
|
467
|
-
[](https://lmstudio.ai/blog/lmstudio-v0.3.17)
|
|
468
|
-
|
|
469
440
|
Program → Install → Edit `mcp.json`:
|
|
470
441
|
|
|
471
442
|
```json
|
|
@@ -479,13 +450,13 @@ Program → Install → Edit `mcp.json`:
|
|
|
479
450
|
}
|
|
480
451
|
```
|
|
481
452
|
|
|
453
|
+
[](https://lmstudio.ai/blog/lmstudio-v0.3.17)
|
|
454
|
+
|
|
482
455
|
</details>
|
|
483
456
|
|
|
484
457
|
<details>
|
|
485
458
|
<summary><strong>Visual Studio 2022</strong></summary>
|
|
486
459
|
|
|
487
|
-
[](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022)
|
|
488
|
-
|
|
489
460
|
```json
|
|
490
461
|
{
|
|
491
462
|
"mcp": {
|
|
@@ -500,13 +471,13 @@ Program → Install → Edit `mcp.json`:
|
|
|
500
471
|
}
|
|
501
472
|
```
|
|
502
473
|
|
|
474
|
+
[](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022)
|
|
475
|
+
|
|
503
476
|
</details>
|
|
504
477
|
|
|
505
478
|
<details>
|
|
506
479
|
<summary><strong>BoltAI</strong></summary>
|
|
507
480
|
|
|
508
|
-
[](https://docs.boltai.com/docs/plugins/mcp-servers)
|
|
509
|
-
|
|
510
481
|
```json
|
|
511
482
|
{
|
|
512
483
|
"mcpServers": {
|
|
@@ -518,13 +489,13 @@ Program → Install → Edit `mcp.json`:
|
|
|
518
489
|
}
|
|
519
490
|
```
|
|
520
491
|
|
|
492
|
+
[](https://docs.boltai.com/docs/plugins/mcp-servers)
|
|
493
|
+
|
|
521
494
|
</details>
|
|
522
495
|
|
|
523
496
|
<details>
|
|
524
497
|
<summary><strong>Perplexity Desktop</strong></summary>
|
|
525
498
|
|
|
526
|
-
[](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity)
|
|
527
|
-
|
|
528
499
|
Perplexity → Settings → Connectors → Add Connector → Advanced → Server Name: `crush-protocol`
|
|
529
500
|
|
|
530
501
|
```json
|
|
@@ -535,13 +506,13 @@ Perplexity → Settings → Connectors → Add Connector → Advanced → Server
|
|
|
535
506
|
}
|
|
536
507
|
```
|
|
537
508
|
|
|
509
|
+
[](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity)
|
|
510
|
+
|
|
538
511
|
</details>
|
|
539
512
|
|
|
540
513
|
<details>
|
|
541
514
|
<summary><strong>Kilo Code</strong></summary>
|
|
542
515
|
|
|
543
|
-
[](https://kilocode.ai)
|
|
544
|
-
|
|
545
516
|
```json
|
|
546
517
|
{
|
|
547
518
|
"mcpServers": {
|
|
@@ -553,13 +524,13 @@ Perplexity → Settings → Connectors → Add Connector → Advanced → Server
|
|
|
553
524
|
}
|
|
554
525
|
```
|
|
555
526
|
|
|
527
|
+
[](https://kilocode.ai)
|
|
528
|
+
|
|
556
529
|
</details>
|
|
557
530
|
|
|
558
531
|
<details>
|
|
559
532
|
<summary><strong>Zencoder</strong></summary>
|
|
560
533
|
|
|
561
|
-
[](https://zencoder.ai)
|
|
562
|
-
|
|
563
534
|
Zencoder menu → Agent tools → Add custom MCP:
|
|
564
535
|
|
|
565
536
|
```json
|
|
@@ -569,13 +540,13 @@ Zencoder menu → Agent tools → Add custom MCP:
|
|
|
569
540
|
}
|
|
570
541
|
```
|
|
571
542
|
|
|
543
|
+
[](https://zencoder.ai)
|
|
544
|
+
|
|
572
545
|
</details>
|
|
573
546
|
|
|
574
547
|
<details>
|
|
575
548
|
<summary><strong>Qodo Gen</strong></summary>
|
|
576
549
|
|
|
577
|
-
[](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps)
|
|
578
|
-
|
|
579
550
|
Qodo Gen chat → Connect more tools → `+ Add new MCP`
|
|
580
551
|
|
|
581
552
|
```json
|
|
@@ -589,6 +560,8 @@ Qodo Gen chat → Connect more tools → `+ Add new MCP`
|
|
|
589
560
|
}
|
|
590
561
|
```
|
|
591
562
|
|
|
563
|
+
[](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps)
|
|
564
|
+
|
|
592
565
|
</details>
|
|
593
566
|
|
|
594
567
|
<details>
|