@crush-protocol/mcp-client 0.4.14 → 0.4.16

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 (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +100 -8
  3. package/dist/cli.js +0 -0
  4. package/package.json +67 -68
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Edwin Hernandez
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -38,13 +38,35 @@ Recommended:
38
38
  npx -y @crush-protocol/mcp-client setup --all
39
39
  ```
40
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`
41
+ This writes MCP config for all supported hosts at once. To target a single host:
42
+
43
+ ```sh
44
+ npx -y @crush-protocol/mcp-client setup --cursor
45
+ npx -y @crush-protocol/mcp-client setup --claude
46
+ npx -y @crush-protocol/mcp-client setup --codex
47
+ npx -y @crush-protocol/mcp-client setup --gemini
48
+ npx -y @crush-protocol/mcp-client setup --opencode
49
+ npx -y @crush-protocol/mcp-client setup --vscode
50
+ npx -y @crush-protocol/mcp-client setup --windsurf
51
+ npx -y @crush-protocol/mcp-client setup --claude-desktop
52
+ npx -y @crush-protocol/mcp-client setup --warp
53
+ ```
54
+
55
+ Cursor and VS Code also support `--scope project` for repo-local config.
42
56
 
43
57
  ### Client Configuration
44
58
 
45
59
  <details>
46
60
  <summary><strong>Cursor</strong></summary>
47
61
 
62
+ **Auto setup:**
63
+
64
+ ```sh
65
+ npx -y @crush-protocol/mcp-client setup --cursor
66
+ ```
67
+
68
+ **Manual config:** Add to `~/.cursor/mcp.json`:
69
+
48
70
  [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=crush-protocol&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjcnVzaC1wcm90b2NvbC9tY3AtY2xpZW50Il19)
49
71
 
50
72
  ```json
@@ -65,6 +87,14 @@ This writes MCP config for all supported hosts at once. To target a single host:
65
87
  <details>
66
88
  <summary><strong>Claude Code</strong></summary>
67
89
 
90
+ **Auto setup:**
91
+
92
+ ```sh
93
+ npx -y @crush-protocol/mcp-client setup --claude
94
+ ```
95
+
96
+ **Manual config:**
97
+
68
98
  ```sh
69
99
  claude mcp add --scope user crush-protocol -- npx -y @crush-protocol/mcp-client
70
100
  ```
@@ -76,9 +106,17 @@ claude mcp add --scope user crush-protocol -- npx -y @crush-protocol/mcp-client
76
106
  <details>
77
107
  <summary><strong>OpenAI Codex</strong></summary>
78
108
 
109
+ **Auto setup:**
110
+
111
+ ```sh
112
+ npx -y @crush-protocol/mcp-client setup --codex
113
+ ```
114
+
115
+ **Manual config:**
116
+
79
117
  **CLI:** `codex mcp add crush-protocol -- npx -y @crush-protocol/mcp-client`
80
118
 
81
- **Local** (add to `~/.codex/config.toml`):
119
+ **File:** Add to `~/.codex/config.toml`:
82
120
 
83
121
  ```toml
84
122
  [mcp_servers.crush-protocol]
@@ -94,7 +132,13 @@ startup_timeout_ms = 20000
94
132
  <details>
95
133
  <summary><strong>Google Gemini CLI</strong></summary>
96
134
 
97
- Add to `~/.gemini/settings.json`:
135
+ **Auto setup:**
136
+
137
+ ```sh
138
+ npx -y @crush-protocol/mcp-client setup --gemini
139
+ ```
140
+
141
+ **Manual config:** Add to `~/.gemini/settings.json`:
98
142
 
99
143
  ```json
100
144
  {
@@ -114,7 +158,13 @@ Add to `~/.gemini/settings.json`:
114
158
  <details>
115
159
  <summary><strong>VS Code</strong></summary>
116
160
 
117
- Add to `.vscode/mcp.json`:
161
+ **Auto setup:**
162
+
163
+ ```sh
164
+ npx -y @crush-protocol/mcp-client setup --vscode
165
+ ```
166
+
167
+ **Manual config:** Add to `.vscode/mcp.json` (project) or `~/.vscode/mcp.json` (global):
118
168
 
119
169
  ```json
120
170
  {
@@ -135,6 +185,14 @@ Add to `.vscode/mcp.json`:
135
185
  <details>
136
186
  <summary><strong>Windsurf</strong></summary>
137
187
 
188
+ **Auto setup:**
189
+
190
+ ```sh
191
+ npx -y @crush-protocol/mcp-client setup --windsurf
192
+ ```
193
+
194
+ **Manual config:** Add to `~/.codeium/windsurf/mcp_config.json`:
195
+
138
196
  ```json
139
197
  {
140
198
  "mcpServers": {
@@ -153,7 +211,13 @@ Add to `.vscode/mcp.json`:
153
211
  <details>
154
212
  <summary><strong>Claude Desktop</strong></summary>
155
213
 
156
- Edit `claude_desktop_config.json`:
214
+ **Auto setup:**
215
+
216
+ ```sh
217
+ npx -y @crush-protocol/mcp-client setup --claude-desktop
218
+ ```
219
+
220
+ **Manual config:** Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
157
221
 
158
222
  ```json
159
223
  {
@@ -173,7 +237,13 @@ Edit `claude_desktop_config.json`:
173
237
  <details>
174
238
  <summary><strong>OpenCode</strong></summary>
175
239
 
176
- Add to `~/.config/opencode/opencode.json`:
240
+ **Auto setup:**
241
+
242
+ ```sh
243
+ npx -y @crush-protocol/mcp-client setup --opencode
244
+ ```
245
+
246
+ **Manual config:** Add to `~/.config/opencode/opencode.json`:
177
247
 
178
248
  ```json
179
249
  {
@@ -195,6 +265,14 @@ Add to `~/.config/opencode/opencode.json`:
195
265
  <details>
196
266
  <summary><strong>Warp</strong></summary>
197
267
 
268
+ **Auto setup:**
269
+
270
+ ```sh
271
+ npx -y @crush-protocol/mcp-client setup --warp
272
+ ```
273
+
274
+ **Manual config:** Go to `Warp Drive` → `MCP Servers` → `+ Add`, then paste:
275
+
198
276
  ```json
199
277
  {
200
278
  "crush-protocol": {
@@ -207,13 +285,15 @@ Add to `~/.config/opencode/opencode.json`:
207
285
  }
208
286
  ```
209
287
 
210
- [![Docs](https://img.shields.io/badge/docs-Warp-01A4FF?style=flat)](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server)
288
+ [![Docs](https://img.shields.io/badge/docs-Warp-01A4FF?style=flat)](https://docs.warp.dev/agent-platform/capabilities/mcp)
211
289
 
212
290
  </details>
213
291
 
214
292
  <details>
215
293
  <summary><strong>Kiro</strong></summary>
216
294
 
295
+ Add to `~/.kiro/settings/mcp.json` (global) or `.kiro/settings/mcp.json` (workspace):
296
+
217
297
  ```json
218
298
  {
219
299
  "mcpServers": {
@@ -232,6 +312,8 @@ Add to `~/.config/opencode/opencode.json`:
232
312
  <details>
233
313
  <summary><strong>Roo Code</strong></summary>
234
314
 
315
+ Open Roo Code settings → `Edit Global MCP`. Or add to `.roo/mcp.json` (project):
316
+
235
317
  ```json
236
318
  {
237
319
  "mcpServers": {
@@ -250,6 +332,8 @@ Add to `~/.config/opencode/opencode.json`:
250
332
  <details>
251
333
  <summary><strong>Cline</strong></summary>
252
334
 
335
+ Open Cline panel → MCP Servers → `Configure MCP Servers`:
336
+
253
337
  ```json
254
338
  {
255
339
  "mcpServers": {
@@ -268,6 +352,8 @@ Add to `~/.config/opencode/opencode.json`:
268
352
  <details>
269
353
  <summary><strong>Trae</strong></summary>
270
354
 
355
+ Trae → Settings → MCP → `Add MCP Server`:
356
+
271
357
  ```json
272
358
  {
273
359
  "mcpServers": {
@@ -307,6 +393,8 @@ Hamburger menu → Settings → Tools → `+ Add MCP` → Command: `npx -y @crus
307
393
  <details>
308
394
  <summary><strong>Copilot Coding Agent</strong></summary>
309
395
 
396
+ Add to `.github/copilot/mcp.json` in your repository:
397
+
310
398
  ```json
311
399
  {
312
400
  "mcpServers": {
@@ -347,6 +435,8 @@ Add to `~/.copilot/mcp-config.json`:
347
435
  <details>
348
436
  <summary><strong>Amazon Q Developer CLI</strong></summary>
349
437
 
438
+ Add to `~/.aws/amazonq/mcp.json`:
439
+
350
440
  ```json
351
441
  {
352
442
  "mcpServers": {
@@ -376,7 +466,7 @@ amp mcp add crush-protocol -- npx -y @crush-protocol/mcp-client
376
466
  <details>
377
467
  <summary><strong>Zed</strong></summary>
378
468
 
379
- Add to `settings.json`:
469
+ Add to `~/.config/zed/settings.json`:
380
470
 
381
471
  ```json
382
472
  {
@@ -457,6 +547,8 @@ Program → Install → Edit `mcp.json`:
457
547
  <details>
458
548
  <summary><strong>Visual Studio 2022</strong></summary>
459
549
 
550
+ Add to `.mcp/mcp.json` in your solution directory:
551
+
460
552
  ```json
461
553
  {
462
554
  "mcp": {
package/dist/cli.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,69 +1,68 @@
1
1
  {
2
- "name": "@crush-protocol/mcp-client",
3
- "version": "0.4.14",
4
- "description": "Official Crush MCP client for hosted market data, backtests, and trading workflows",
5
- "type": "module",
6
- "license": "MIT",
7
- "homepage": "https://github.com/crush-protocol/crush-mcp-server/tree/main/packages/crush-mcp-client#readme",
8
- "repository": {
9
- "type": "git",
10
- "url": "https://github.com/crush-protocol/crush-mcp-server.git",
11
- "directory": "packages/crush-mcp-client"
12
- },
13
- "bugs": {
14
- "url": "https://github.com/crush-protocol/crush-mcp-server/issues"
15
- },
16
- "keywords": [
17
- "crush",
18
- "crush-protocol",
19
- "mcp",
20
- "model-context-protocol",
21
- "trading",
22
- "backtest",
23
- "quant",
24
- "cursor",
25
- "claude-code",
26
- "codex"
27
- ],
28
- "main": "dist/index.js",
29
- "types": "dist/index.d.ts",
30
- "bin": {
31
- "crush-mcp-client": "dist/cli.js"
32
- },
33
- "files": [
34
- "dist",
35
- "INSTRUCTIONS.md"
36
- ],
37
- "publishConfig": {
38
- "access": "public"
39
- },
40
- "exports": {
41
- ".": {
42
- "types": "./dist/index.d.ts",
43
- "default": "./dist/index.js"
44
- }
45
- },
46
- "scripts": {
47
- "build": "rm -rf dist && tsc -p tsconfig.json",
48
- "dev": "tsx src/cli.ts",
49
- "test": "vitest run",
50
- "test:e2e": "dotenv -e .env.e2e vitest run src/__tests__/e2e.test.ts",
51
- "prepublishOnly": "pnpm run build"
52
- },
53
- "dependencies": {
54
- "@crush-protocol/mcp-contracts": "workspace:*",
55
- "@modelcontextprotocol/sdk": "^1.26.0",
56
- "dotenv": "^17.2.1",
57
- "zod": "^3.25.76"
58
- },
59
- "devDependencies": {
60
- "@types/node": "^24.3.0",
61
- "dotenv-cli": "^8.0.0",
62
- "tsx": "^4.20.4",
63
- "typescript": "^5.9.2",
64
- "vitest": "^3.2.4"
65
- },
66
- "engines": {
67
- "node": ">=20"
68
- }
69
- }
2
+ "name": "@crush-protocol/mcp-client",
3
+ "version": "0.4.16",
4
+ "description": "Official Crush MCP client for hosted market data, backtests, and trading workflows",
5
+ "type": "module",
6
+ "license": "MIT",
7
+ "homepage": "https://github.com/crush-protocol/crush-mcp-server/tree/main/packages/crush-mcp-client#readme",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "https://github.com/crush-protocol/crush-mcp-server.git",
11
+ "directory": "packages/crush-mcp-client"
12
+ },
13
+ "bugs": {
14
+ "url": "https://github.com/crush-protocol/crush-mcp-server/issues"
15
+ },
16
+ "keywords": [
17
+ "crush",
18
+ "crush-protocol",
19
+ "mcp",
20
+ "model-context-protocol",
21
+ "trading",
22
+ "backtest",
23
+ "quant",
24
+ "cursor",
25
+ "claude-code",
26
+ "codex"
27
+ ],
28
+ "main": "dist/index.js",
29
+ "types": "dist/index.d.ts",
30
+ "bin": {
31
+ "crush-mcp-client": "dist/cli.js"
32
+ },
33
+ "files": [
34
+ "dist",
35
+ "INSTRUCTIONS.md"
36
+ ],
37
+ "publishConfig": {
38
+ "access": "public"
39
+ },
40
+ "exports": {
41
+ ".": {
42
+ "types": "./dist/index.d.ts",
43
+ "default": "./dist/index.js"
44
+ }
45
+ },
46
+ "dependencies": {
47
+ "@modelcontextprotocol/sdk": "^1.26.0",
48
+ "dotenv": "^17.2.1",
49
+ "zod": "^3.25.76",
50
+ "@crush-protocol/mcp-contracts": "0.1.2"
51
+ },
52
+ "devDependencies": {
53
+ "@types/node": "^24.3.0",
54
+ "dotenv-cli": "^8.0.0",
55
+ "tsx": "^4.20.4",
56
+ "typescript": "^5.9.2",
57
+ "vitest": "^3.2.4"
58
+ },
59
+ "engines": {
60
+ "node": ">=20"
61
+ },
62
+ "scripts": {
63
+ "build": "rm -rf dist && tsc -p tsconfig.json",
64
+ "dev": "tsx src/cli.ts",
65
+ "test": "vitest run",
66
+ "test:e2e": "dotenv -e .env.e2e vitest run src/__tests__/e2e.test.ts"
67
+ }
68
+ }