@crush-protocol/mcp-client 0.4.9 → 0.4.11

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.
Files changed (2) hide show
  1. package/README.md +567 -37
  2. 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
- ## For AI Agents
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
- 1. `setup` writes MCP config for your host.
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
 
@@ -62,20 +35,66 @@ Detailed tool guidance:
62
35
  Recommended:
63
36
 
64
37
  ```sh
65
- npx -y @crush-protocol/mcp-client setup --cursor
38
+ npx -y @crush-protocol/mcp-client setup --all
66
39
  ```
67
40
 
41
+ This writes MCP config for all supported hosts at once. To target a single host: `npx -y @crush-protocol/mcp-client setup --cursor`
42
+
43
+ ### Client Configuration
44
+
68
45
  <details>
69
- <summary>Show Cursor install details</summary>
46
+ <summary><h4>Cursor</h4></summary>
47
+
48
+ [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=crush-protocol&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjcnVzaC1wcm90b2NvbC9tY3AtY2xpZW50Il19)
49
+
50
+ ```json
51
+ {
52
+ "mcpServers": {
53
+ "crush-protocol": {
54
+ "command": "npx",
55
+ "args": ["-y", "@crush-protocol/mcp-client"]
56
+ }
57
+ }
58
+ }
59
+ ```
60
+
61
+ [![Docs](https://img.shields.io/badge/Cursor_MCP_Docs-black?style=flat&logo=cursor&logoColor=white)](https://docs.cursor.com/context/model-context-protocol)
62
+
63
+ </details>
64
+
65
+ <details>
66
+ <summary><h4>Claude Code</h4></summary>
70
67
 
71
68
  ```sh
72
- npx -y @crush-protocol/mcp-client setup --cursor
73
- npx -y @crush-protocol/mcp-client login
69
+ claude mcp add --scope user crush-protocol -- npx -y @crush-protocol/mcp-client
70
+ ```
71
+
72
+ [![Docs](https://img.shields.io/badge/Claude_Code_MCP_Docs-black?style=flat&logo=anthropic&logoColor=white)](https://docs.anthropic.com/en/docs/claude-code/mcp)
73
+
74
+ </details>
75
+
76
+ <details>
77
+ <summary><h4>OpenAI Codex</h4></summary>
78
+
79
+ **CLI:** `codex mcp add crush-protocol -- npx -y @crush-protocol/mcp-client`
80
+
81
+ **Local** (add to `~/.codex/config.toml`):
82
+
83
+ ```toml
84
+ [mcp_servers.crush-protocol]
85
+ command = "npx"
86
+ args = ["-y", "@crush-protocol/mcp-client"]
87
+ startup_timeout_ms = 20000
74
88
  ```
75
89
 
90
+ [![Docs](https://img.shields.io/badge/Codex_MCP_Docs-black?style=flat&logo=openai&logoColor=white)](https://developers.openai.com/codex/mcp)
91
+
76
92
  </details>
77
93
 
78
- Manual MCP host config:
94
+ <details>
95
+ <summary><h4>Google Gemini CLI</h4></summary>
96
+
97
+ Add to `~/.gemini/settings.json`:
79
98
 
80
99
  ```json
81
100
  {
@@ -88,6 +107,517 @@ Manual MCP host config:
88
107
  }
89
108
  ```
90
109
 
110
+ [![Docs](https://img.shields.io/badge/Gemini_CLI_Docs-black?style=flat&logo=google&logoColor=white)](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html)
111
+
112
+ </details>
113
+
114
+ <details>
115
+ <summary><h4>VS Code</h4></summary>
116
+
117
+ Add to `.vscode/mcp.json`:
118
+
119
+ ```json
120
+ {
121
+ "servers": {
122
+ "crush-protocol": {
123
+ "type": "stdio",
124
+ "command": "npx",
125
+ "args": ["-y", "@crush-protocol/mcp-client"]
126
+ }
127
+ }
128
+ }
129
+ ```
130
+
131
+ [![Docs](https://img.shields.io/badge/VS_Code_MCP_Docs-black?style=flat&logo=visualstudiocode&logoColor=white)](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
132
+
133
+ </details>
134
+
135
+ <details>
136
+ <summary><h4>Windsurf</h4></summary>
137
+
138
+ ```json
139
+ {
140
+ "mcpServers": {
141
+ "crush-protocol": {
142
+ "command": "npx",
143
+ "args": ["-y", "@crush-protocol/mcp-client"]
144
+ }
145
+ }
146
+ }
147
+ ```
148
+
149
+ [![Docs](https://img.shields.io/badge/Windsurf_MCP_Docs-black?style=flat&logo=windsurf&logoColor=white)](https://docs.windsurf.com/windsurf/cascade/mcp)
150
+
151
+ </details>
152
+
153
+ <details>
154
+ <summary><h4>Claude Desktop</h4></summary>
155
+
156
+ Edit `claude_desktop_config.json`:
157
+
158
+ ```json
159
+ {
160
+ "mcpServers": {
161
+ "crush-protocol": {
162
+ "command": "npx",
163
+ "args": ["-y", "@crush-protocol/mcp-client"]
164
+ }
165
+ }
166
+ }
167
+ ```
168
+
169
+ [![Docs](https://img.shields.io/badge/Claude_Desktop_MCP_Docs-black?style=flat&logo=anthropic&logoColor=white)](https://modelcontextprotocol.io/quickstart/user)
170
+
171
+ </details>
172
+
173
+ <details>
174
+ <summary><h4>OpenCode</h4></summary>
175
+
176
+ Add to `~/.config/opencode/opencode.json`:
177
+
178
+ ```json
179
+ {
180
+ "$schema": "https://opencode.ai/config.json",
181
+ "mcp": {
182
+ "crush-protocol": {
183
+ "type": "local",
184
+ "command": ["npx", "-y", "@crush-protocol/mcp-client"],
185
+ "enabled": true
186
+ }
187
+ }
188
+ }
189
+ ```
190
+
191
+ [![Docs](https://img.shields.io/badge/OpenCode_MCP_Docs-black?style=flat)](https://opencode.ai/docs/mcp-servers)
192
+
193
+ </details>
194
+
195
+ <details>
196
+ <summary><h4>Warp</h4></summary>
197
+
198
+ ```json
199
+ {
200
+ "crush-protocol": {
201
+ "command": "npx",
202
+ "args": ["-y", "@crush-protocol/mcp-client"],
203
+ "env": {},
204
+ "working_directory": null,
205
+ "start_on_launch": true
206
+ }
207
+ }
208
+ ```
209
+
210
+ [![Docs](https://img.shields.io/badge/Warp_MCP_Docs-black?style=flat&logo=warp&logoColor=white)](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server)
211
+
212
+ </details>
213
+
214
+ <details>
215
+ <summary><h4>Kiro</h4></summary>
216
+
217
+ ```json
218
+ {
219
+ "mcpServers": {
220
+ "crush-protocol": {
221
+ "command": "npx",
222
+ "args": ["-y", "@crush-protocol/mcp-client"]
223
+ }
224
+ }
225
+ }
226
+ ```
227
+
228
+ [![Docs](https://img.shields.io/badge/Kiro_MCP_Docs-black?style=flat)](https://kiro.dev/docs/mcp/configuration/)
229
+
230
+ </details>
231
+
232
+ <details>
233
+ <summary><h4>Roo Code</h4></summary>
234
+
235
+ ```json
236
+ {
237
+ "mcpServers": {
238
+ "crush-protocol": {
239
+ "command": "npx",
240
+ "args": ["-y", "@crush-protocol/mcp-client"]
241
+ }
242
+ }
243
+ }
244
+ ```
245
+
246
+ [![Docs](https://img.shields.io/badge/Roo_Code_MCP_Docs-black?style=flat)](https://docs.roocode.com/features/mcp/using-mcp-in-roo)
247
+
248
+ </details>
249
+
250
+ <details>
251
+ <summary><h4>Cline</h4></summary>
252
+
253
+ ```json
254
+ {
255
+ "mcpServers": {
256
+ "crush-protocol": {
257
+ "command": "npx",
258
+ "args": ["-y", "@crush-protocol/mcp-client"]
259
+ }
260
+ }
261
+ }
262
+ ```
263
+
264
+ [![Docs](https://img.shields.io/badge/Cline_MCP_Marketplace-black?style=flat)](https://cline.bot/mcp-marketplace)
265
+
266
+ </details>
267
+
268
+ <details>
269
+ <summary><h4>Trae</h4></summary>
270
+
271
+ ```json
272
+ {
273
+ "mcpServers": {
274
+ "crush-protocol": {
275
+ "command": "npx",
276
+ "args": ["-y", "@crush-protocol/mcp-client"]
277
+ }
278
+ }
279
+ }
280
+ ```
281
+
282
+ [![Docs](https://img.shields.io/badge/Trae_MCP_Docs-black?style=flat)](https://docs.trae.ai/ide/model-context-protocol?_lang=en)
283
+
284
+ </details>
285
+
286
+ <details>
287
+ <summary><h4>Augment Code</h4></summary>
288
+
289
+ Hamburger menu → Settings → Tools → `+ Add MCP` → Command: `npx -y @crush-protocol/mcp-client`
290
+
291
+ ```json
292
+ "augment.advanced": {
293
+ "mcpServers": [
294
+ {
295
+ "name": "crush-protocol",
296
+ "command": "npx",
297
+ "args": ["-y", "@crush-protocol/mcp-client"]
298
+ }
299
+ ]
300
+ }
301
+ ```
302
+
303
+ [![Docs](https://img.shields.io/badge/Augment_Code_Docs-black?style=flat)](https://docs.augmentcode.com/)
304
+
305
+ </details>
306
+
307
+ <details>
308
+ <summary><h4>Copilot Coding Agent</h4></summary>
309
+
310
+ ```json
311
+ {
312
+ "mcpServers": {
313
+ "crush-protocol": {
314
+ "type": "local",
315
+ "command": "npx",
316
+ "args": ["-y", "@crush-protocol/mcp-client"]
317
+ }
318
+ }
319
+ }
320
+ ```
321
+
322
+ [![Docs](https://img.shields.io/badge/Copilot_MCP_Docs-black?style=flat&logo=github&logoColor=white)](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp)
323
+
324
+ </details>
325
+
326
+ <details>
327
+ <summary><h4>Copilot CLI</h4></summary>
328
+
329
+ Add to `~/.copilot/mcp-config.json`:
330
+
331
+ ```json
332
+ {
333
+ "mcpServers": {
334
+ "crush-protocol": {
335
+ "type": "local",
336
+ "command": "npx",
337
+ "args": ["-y", "@crush-protocol/mcp-client"]
338
+ }
339
+ }
340
+ }
341
+ ```
342
+
343
+ [![Docs](https://img.shields.io/badge/Copilot_CLI_Docs-black?style=flat&logo=github&logoColor=white)](https://docs.github.com/copilot)
344
+
345
+ </details>
346
+
347
+ <details>
348
+ <summary><h4>Amazon Q Developer CLI</h4></summary>
349
+
350
+ ```json
351
+ {
352
+ "mcpServers": {
353
+ "crush-protocol": {
354
+ "command": "npx",
355
+ "args": ["-y", "@crush-protocol/mcp-client"]
356
+ }
357
+ }
358
+ }
359
+ ```
360
+
361
+ [![Docs](https://img.shields.io/badge/Amazon_Q_CLI_Docs-black?style=flat&logo=amazonaws&logoColor=white)](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html)
362
+
363
+ </details>
364
+
365
+ <details>
366
+ <summary><h4>Amp</h4></summary>
367
+
368
+ ```sh
369
+ amp mcp add crush-protocol -- npx -y @crush-protocol/mcp-client
370
+ ```
371
+
372
+ [![Docs](https://img.shields.io/badge/Amp_MCP_Docs-black?style=flat)](https://ampcode.com/manual#mcp)
373
+
374
+ </details>
375
+
376
+ <details>
377
+ <summary><h4>Zed</h4></summary>
378
+
379
+ Add to `settings.json`:
380
+
381
+ ```json
382
+ {
383
+ "context_servers": {
384
+ "crush-protocol": {
385
+ "source": "custom",
386
+ "command": "npx",
387
+ "args": ["-y", "@crush-protocol/mcp-client"]
388
+ }
389
+ }
390
+ }
391
+ ```
392
+
393
+ [![Docs](https://img.shields.io/badge/Zed_Context_Server_Docs-black?style=flat)](https://zed.dev/docs/assistant/context-servers)
394
+
395
+ </details>
396
+
397
+ <details>
398
+ <summary><h4>JetBrains AI Assistant</h4></summary>
399
+
400
+ Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`
401
+
402
+ ```json
403
+ {
404
+ "mcpServers": {
405
+ "crush-protocol": {
406
+ "command": "npx",
407
+ "args": ["-y", "@crush-protocol/mcp-client"]
408
+ }
409
+ }
410
+ }
411
+ ```
412
+
413
+ [![Docs](https://img.shields.io/badge/JetBrains_AI_Docs-black?style=flat&logo=jetbrains&logoColor=white)](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html)
414
+
415
+ </details>
416
+
417
+ <details>
418
+ <summary><h4>Qwen Code</h4></summary>
419
+
420
+ **CLI:** `qwen mcp add crush-protocol npx -y @crush-protocol/mcp-client`
421
+
422
+ ```json
423
+ {
424
+ "mcpServers": {
425
+ "crush-protocol": {
426
+ "command": "npx",
427
+ "args": ["-y", "@crush-protocol/mcp-client"]
428
+ }
429
+ }
430
+ }
431
+ ```
432
+
433
+ [![Docs](https://img.shields.io/badge/Qwen_Code_MCP_Docs-black?style=flat)](https://qwenlm.github.io/qwen-code-docs/en/users/features/mcp/)
434
+
435
+ </details>
436
+
437
+ <details>
438
+ <summary><h4>LM Studio</h4></summary>
439
+
440
+ Program → Install → Edit `mcp.json`:
441
+
442
+ ```json
443
+ {
444
+ "mcpServers": {
445
+ "crush-protocol": {
446
+ "command": "npx",
447
+ "args": ["-y", "@crush-protocol/mcp-client"]
448
+ }
449
+ }
450
+ }
451
+ ```
452
+
453
+ [![Docs](https://img.shields.io/badge/LM_Studio_MCP_Docs-black?style=flat)](https://lmstudio.ai/blog/lmstudio-v0.3.17)
454
+
455
+ </details>
456
+
457
+ <details>
458
+ <summary><h4>Visual Studio 2022</h4></summary>
459
+
460
+ ```json
461
+ {
462
+ "mcp": {
463
+ "servers": {
464
+ "crush-protocol": {
465
+ "type": "stdio",
466
+ "command": "npx",
467
+ "args": ["-y", "@crush-protocol/mcp-client"]
468
+ }
469
+ }
470
+ }
471
+ }
472
+ ```
473
+
474
+ [![Docs](https://img.shields.io/badge/VS_2022_MCP_Docs-black?style=flat&logo=visualstudio&logoColor=white)](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022)
475
+
476
+ </details>
477
+
478
+ <details>
479
+ <summary><h4>BoltAI</h4></summary>
480
+
481
+ ```json
482
+ {
483
+ "mcpServers": {
484
+ "crush-protocol": {
485
+ "command": "npx",
486
+ "args": ["-y", "@crush-protocol/mcp-client"]
487
+ }
488
+ }
489
+ }
490
+ ```
491
+
492
+ [![Docs](https://img.shields.io/badge/BoltAI_Docs-black?style=flat)](https://docs.boltai.com/docs/plugins/mcp-servers)
493
+
494
+ </details>
495
+
496
+ <details>
497
+ <summary><h4>Perplexity Desktop</h4></summary>
498
+
499
+ Perplexity → Settings → Connectors → Add Connector → Advanced → Server Name: `crush-protocol`
500
+
501
+ ```json
502
+ {
503
+ "args": ["-y", "@crush-protocol/mcp-client"],
504
+ "command": "npx",
505
+ "env": {}
506
+ }
507
+ ```
508
+
509
+ [![Docs](https://img.shields.io/badge/Perplexity_MCP_Docs-black?style=flat)](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity)
510
+
511
+ </details>
512
+
513
+ <details>
514
+ <summary><h4>Kilo Code</h4></summary>
515
+
516
+ ```json
517
+ {
518
+ "mcpServers": {
519
+ "crush-protocol": {
520
+ "command": "npx",
521
+ "args": ["-y", "@crush-protocol/mcp-client"]
522
+ }
523
+ }
524
+ }
525
+ ```
526
+
527
+ [![Docs](https://img.shields.io/badge/Kilo_Code_Docs-black?style=flat)](https://kilocode.ai)
528
+
529
+ </details>
530
+
531
+ <details>
532
+ <summary><h4>Zencoder</h4></summary>
533
+
534
+ Zencoder menu → Agent tools → Add custom MCP:
535
+
536
+ ```json
537
+ {
538
+ "command": "npx",
539
+ "args": ["-y", "@crush-protocol/mcp-client"]
540
+ }
541
+ ```
542
+
543
+ [![Docs](https://img.shields.io/badge/Zencoder_Docs-black?style=flat)](https://zencoder.ai)
544
+
545
+ </details>
546
+
547
+ <details>
548
+ <summary><h4>Qodo Gen</h4></summary>
549
+
550
+ Qodo Gen chat → Connect more tools → `+ Add new MCP`
551
+
552
+ ```json
553
+ {
554
+ "mcpServers": {
555
+ "crush-protocol": {
556
+ "command": "npx",
557
+ "args": ["-y", "@crush-protocol/mcp-client"]
558
+ }
559
+ }
560
+ }
561
+ ```
562
+
563
+ [![Docs](https://img.shields.io/badge/Qodo_Gen_Docs-black?style=flat)](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps)
564
+
565
+ </details>
566
+
567
+ <details>
568
+ <summary><h4>Using Bun or Deno</h4></summary>
569
+
570
+ **Bun:**
571
+
572
+ ```json
573
+ {
574
+ "mcpServers": {
575
+ "crush-protocol": {
576
+ "command": "bunx",
577
+ "args": ["-y", "@crush-protocol/mcp-client"]
578
+ }
579
+ }
580
+ }
581
+ ```
582
+
583
+ **Deno:**
584
+
585
+ ```json
586
+ {
587
+ "mcpServers": {
588
+ "crush-protocol": {
589
+ "command": "deno",
590
+ "args": [
591
+ "run",
592
+ "--allow-env",
593
+ "--allow-net",
594
+ "--allow-read",
595
+ "--allow-write",
596
+ "npm:@crush-protocol/mcp-client"
597
+ ]
598
+ }
599
+ }
600
+ }
601
+ ```
602
+
603
+ </details>
604
+
605
+ <details>
606
+ <summary><h4>Windows</h4></summary>
607
+
608
+ ```json
609
+ {
610
+ "mcpServers": {
611
+ "crush-protocol": {
612
+ "command": "cmd",
613
+ "args": ["/c", "npx", "-y", "@crush-protocol/mcp-client"]
614
+ }
615
+ }
616
+ }
617
+ ```
618
+
619
+ </details>
620
+
91
621
  ## Common Commands
92
622
 
93
623
  ```sh
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crush-protocol/mcp-client",
3
- "version": "0.4.9",
3
+ "version": "0.4.11",
4
4
  "description": "Official Crush MCP client for hosted market data, backtests, and trading workflows",
5
5
  "type": "module",
6
6
  "license": "MIT",