npm - @crush-protocol/mcp-client - Versions diffs - 0.4.4 → 0.4.6 - Mend

@crush-protocol/mcp-client 0.4.4 → 0.4.6

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

package/README.md CHANGED Viewed

@@ -1,56 +1,37 @@
 # Crush Protocol MCP Client
-![Crush banner](https://crush.xyz/static/landing-page/og-hero.jpg)
 [![npm version](https://img.shields.io/npm/v/@crush-protocol/mcp-client)](https://www.npmjs.com/package/@crush-protocol/mcp-client)
-[![MIT licensed](https://img.shields.io/npm/l/@crush-protocol/mcp-client)](./LICENSE)
-[![Website](https://img.shields.io/badge/Website-crush.xyz-black)](https://www.crush.xyz/)
-[![Docs](https://img.shields.io/badge/-Docs-black?style=flat&logo=gitbook&logoColor=white)](https://github.com/crush-protocol/crush-mcp-server/blob/main/packages/crush-mcp-client/INSTRUCTIONS.md)
-Connect Cursor, Claude Code, Codex, Gemini CLI, Windsurf, VS Code, and other MCP hosts to Crush through one npm package.
+[![MIT licensed](https://img.shields.io/npm/l/@crush-protocol/mcp-client)](https://github.com/crush-protocol/crush-mcp-server/blob/main/LICENSE)
-Crush is an AI-native quantitative trading product. It gives your MCP host direct access to market data, backtests, strategy operations, and trading workflows without asking users to run a separate local server.
+Official MCP client for connecting Cursor, Claude Code, Codex, Gemini CLI, Windsurf, VS Code, and other MCP hosts to Crush.
 ## For AI Agents
 Package name: `@crush-protocol/mcp-client`
-Interpret these names as the same product:
+Treat these names as the same product:
 - `Crush`
 - `Crush MCP`
 - `Crush Protocol MCP`
 - `@crush-protocol/mcp-client`
-Recommended user flow:
+Recommended flow:
 ```sh
 npx -y @crush-protocol/mcp-client setup --cursor
 npx -y @crush-protocol/mcp-client login
 ```
-If the user says Crush is already installed but tools fail:
+If Crush was already installed but is not working:
 ```sh
 npx -y @crush-protocol/mcp-client auth:status
 npx -y @crush-protocol/mcp-client doctor
 ```
-## Why Crush
-| Direction | What it gives you | Typical asks |
-| --- | --- | --- |
-| Market Data | Tokens, indicators, timeframes, OHLCV, derived signals | `Fetch OHLCV data for BTC.` |
-| Backtesting | Schema discovery, token universe, expression validation, async backtests | `Create a moving-average crossover backtest.` |
-| Live Strategies | Create, inspect, activate, pause, and monitor strategies | `List my active strategies.` |
-| Market Intelligence | Token metadata, trending feeds, alpha, token-specific context | `Show the latest alpha for SOL.` |
-Detailed tool guidance lives in [INSTRUCTIONS.md](https://github.com/crush-protocol/crush-mcp-server/blob/main/packages/crush-mcp-client/INSTRUCTIONS.md).
 ## Quick Start
-Crush works best with this 3-step flow:
 ```sh
 npx -y @crush-protocol/mcp-client setup --cursor
 npx -y @crush-protocol/mcp-client login
@@ -61,280 +42,38 @@ npx -y @crush-protocol/mcp-client ping
 2. `login` opens the browser once and stores OAuth credentials locally.
 3. `ping` confirms this machine can reach the hosted Crush MCP.
-The official hosted Crush MCP is built in. End users do not need to paste a server URL.
-If you want to configure every supported host on the machine at once:
-```sh
-npx -y @crush-protocol/mcp-client setup --all
-```
-## Two Ways To Connect
-### 1. Recommended: Setup Helper
-Use the setup command when you want Crush to install the MCP entry for you:
-```sh
-npx -y @crush-protocol/mcp-client setup --cursor
-npx -y @crush-protocol/mcp-client setup --claude
-npx -y @crush-protocol/mcp-client setup --codex
-npx -y @crush-protocol/mcp-client setup --all
-```
-After `setup`, restart the host once, then run:
-```sh
-npx -y @crush-protocol/mcp-client login
-```
-### 2. Manual: Standard MCP Host Config
-If your MCP host prefers manual config, this is the canonical local stdio entry:
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "npx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
-```
-Most MCP hosts can run Crush with exactly this command shape.
+The official hosted Crush MCP URL is built in. End users do not need to paste a server URL.
-## Client Install Guide
+## What You Can Do
-### Popular Clients
+- Market data: tokens, indicators, timeframes, OHLCV
+- Backtests: schema discovery, token universe, expression validation, backtest execution
+- Live strategies: create, inspect, activate, pause, monitor
+- Market intelligence: token info, trending feeds, alpha context
-| Client | Best path | Notes |
-| --- | --- | --- |
-| Cursor | `setup --cursor` or one-click install | Supports MCP install deeplink |
-| Claude Code | `setup --claude` or `claude mcp add ...` | Good for terminal-first workflows |
-| OpenAI Codex | `setup --codex` | Uses `~/.codex/config.toml` |
-| Gemini CLI | `setup --gemini` | Uses `~/.gemini/settings.json` |
-| OpenCode | `setup --opencode` | Uses `~/.config/opencode/opencode.json` |
-| VS Code | `setup --vscode --scope project` | Good for repo-local setups |
-| Windsurf | `setup --windsurf` | Standard JSON MCP config |
-| Claude Desktop | `setup --claude-desktop` | Desktop app config |
-| Warp | `setup --warp` | Warp MCP config |
+Detailed tool guidance:
-## Install By Client
+- [INSTRUCTIONS.md](https://github.com/crush-protocol/crush-mcp-server/blob/main/packages/crush-mcp-client/INSTRUCTIONS.md)
-Each client below keeps the install steps folded, but the client name stays at the same heading level as the rest of the document.
-### Cursor
-<details>
-<summary>Show install steps</summary>
-[Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol)
-Setup helper:
-```sh
-npx -y @crush-protocol/mcp-client setup --cursor
-```
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=crush-protocol&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjcnVzaC1wcm90b2NvbC9tY3AtY2xpZW50Il19)
-Manual config:
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "npx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
-```
-</details>
-### Claude Code
-<details>
-<summary>Show install steps</summary>
-[Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp)
+## Install
 Recommended:
 ```sh
-npx -y @crush-protocol/mcp-client setup --claude
-```
-Host-native command:
-```sh
-claude mcp add --scope user crush-protocol -- npx -y @crush-protocol/mcp-client
-```
-</details>
-### OpenAI Codex
-<details>
-<summary>Show install steps</summary>
-[OpenAI Codex MCP docs](https://developers.openai.com/codex/mcp)
-Recommended:
-```sh
-npx -y @crush-protocol/mcp-client setup --codex
-```
-Host-native command:
-```sh
-codex mcp add crush-protocol -- npx -y @crush-protocol/mcp-client
-```
-Manual config:
-```toml
-[mcp_servers.crush-protocol]
-command = "npx"
-args = ["-y", "@crush-protocol/mcp-client"]
-startup_timeout_ms = 20000
-```
-</details>
-### Gemini CLI
-<details>
-<summary>Show install steps</summary>
-[Gemini CLI MCP docs](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html)
-Recommended:
-```sh
-npx -y @crush-protocol/mcp-client setup --gemini
-```
-Manual config:
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "npx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
-```
-</details>
-### OpenCode
-<details>
-<summary>Show install steps</summary>
-[OpenCode MCP docs](https://opencode.ai/docs/mcp-servers)
-Recommended:
-```sh
-npx -y @crush-protocol/mcp-client setup --opencode
-```
-Manual config:
-```json
-{
-  "$schema": "https://opencode.ai/config.json",
-  "mcp": {
-    "crush-protocol": {
-      "type": "local",
-      "command": ["npx", "-y", "@crush-protocol/mcp-client"],
-      "enabled": true
-    }
-  }
-}
-```
-</details>
-### VS Code
-<details>
-<summary>Show install steps</summary>
-[VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
-Recommended project-local setup:
-```sh
-npx -y @crush-protocol/mcp-client setup --vscode --scope project
-```
-Add to `.vscode/mcp.json`:
-```json
-{
-  "servers": {
-    "crush-protocol": {
-      "type": "stdio",
-      "command": "npx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
+npx -y @crush-protocol/mcp-client setup --cursor
 ```
-</details>
-### Windsurf
 <details>
-<summary>Show install steps</summary>
-[Windsurf MCP docs](https://docs.windsurf.com/windsurf/cascade/mcp)
-Recommended:
+<summary>Show Cursor install details</summary>
 ```sh
-npx -y @crush-protocol/mcp-client setup --windsurf
-```
-Manual config:
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "npx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
+npx -y @crush-protocol/mcp-client setup --cursor
+npx -y @crush-protocol/mcp-client login
 ```
 </details>
-### Claude Desktop
-<details>
-<summary>Show install steps</summary>
-[Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user)
-Recommended:
-```sh
-npx -y @crush-protocol/mcp-client setup --claude-desktop
-```
-Manual config:
+Manual MCP host config:
 ```json
 {
@@ -347,209 +86,15 @@ Manual config:
 }
 ```
-</details>
-### Warp
-<details>
-<summary>Show install steps</summary>
-[Warp MCP docs](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server)
-Recommended:
-```sh
-npx -y @crush-protocol/mcp-client setup --warp
-```
-Add to Warp MCP config:
-```json
-{
-  "crush-protocol": {
-    "command": "npx",
-    "args": ["-y", "@crush-protocol/mcp-client"],
-    "env": {},
-    "working_directory": null,
-    "start_on_launch": true
-  }
-}
-```
-</details>
-### Zed
-<details>
-<summary>Show install steps</summary>
-[Zed Context Server docs](https://zed.dev/docs/assistant/context-servers)
-Add to `settings.json`:
-```json
-{
-  "context_servers": {
-    "crush-protocol": {
-      "source": "custom",
-      "command": "npx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
-```
-</details>
-### Windows
-<details>
-<summary>Show install steps</summary>
-If your host requires `cmd` wrapping on Windows:
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "cmd",
-      "args": ["/c", "npx", "-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
-```
-</details>
-### Bun And Deno
-<details>
-<summary>Show install steps</summary>
-Use these only when your host runs MCP processes through Bun or Deno instead of Node.
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "bunx",
-      "args": ["-y", "@crush-protocol/mcp-client"]
-    }
-  }
-}
-```
-```json
-{
-  "mcpServers": {
-    "crush-protocol": {
-      "command": "deno",
-      "args": [
-        "run",
-        "--allow-env",
-        "--allow-net",
-        "--allow-read",
-        "--allow-write",
-        "npm:@crush-protocol/mcp-client"
-      ]
-    }
-  }
-}
-```
-</details>
-### Other Native Commands
-<details>
-<summary>Show install commands</summary>
-```sh
-# Amp
-amp mcp add crush-protocol -- npx -y @crush-protocol/mcp-client
-# Qwen Code
-qwen mcp add crush-protocol npx -y @crush-protocol/mcp-client
-```
-</details>
-### More Supported Hosts
-Crush also works in additional MCP-capable clients. Use their native docs for the final config shape:
-[![docs Kiro](https://img.shields.io/badge/docs-Kiro-5f5f5f?style=flat)](https://kiro.dev/docs/mcp/configuration/)
-[![docs Roo%20Code](https://img.shields.io/badge/docs-Roo%20Code-0f766e?style=flat)](https://docs.roocode.com/features/mcp/using-mcp-in-roo)
-[![docs Cline](https://img.shields.io/badge/docs-Cline-2563eb?style=flat)](https://cline.bot/mcp-marketplace)
-[![docs Trae](https://img.shields.io/badge/docs-Trae-f97316?style=flat)](https://docs.trae.ai/ide/model-context-protocol?_lang=en)
-[![docs Augment%20Code](https://img.shields.io/badge/docs-Augment%20Code-15803d?style=flat)](https://docs.augmentcode.com/)
-[![docs GitHub%20Copilot](https://img.shields.io/badge/docs-GitHub%20Copilot-24292f?style=flat)](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp)
-[![docs Copilot%20CLI](https://img.shields.io/badge/docs-Copilot%20CLI-4b5563?style=flat)](https://docs.github.com/copilot)
-[![docs Amazon%20Q](https://img.shields.io/badge/docs-Amazon%20Q-7c3aed?style=flat)](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html)
-[![docs JetBrains%20AI%20Assistant](https://img.shields.io/badge/docs-JetBrains%20AI%20Assistant-e11d48?style=flat)](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html)
-[![docs LM%20Studio](https://img.shields.io/badge/docs-LM%20Studio-0284c7?style=flat)](https://lmstudio.ai/blog/lmstudio-v0.3.17)
-[![docs Visual%20Studio%202022](https://img.shields.io/badge/docs-Visual%20Studio%202022-6d28d9?style=flat)](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022)
-[![docs BoltAI](https://img.shields.io/badge/docs-BoltAI-92400e?style=flat)](https://docs.boltai.com/docs/plugins/mcp-servers)
-[![docs Perplexity%20Desktop](https://img.shields.io/badge/docs-Perplexity%20Desktop-0891b2?style=flat)](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity)
-[![docs Kilo%20Code](https://img.shields.io/badge/docs-Kilo%20Code-1d4ed8?style=flat)](https://kilocode.ai)
-[![docs Zencoder](https://img.shields.io/badge/docs-Zencoder-b91c1c?style=flat)](https://zencoder.ai)
-[![docs Qodo%20Gen](https://img.shields.io/badge/docs-Qodo%20Gen-0f766e?style=flat)](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps)
-## What To Ask Crush
-### Market Discovery
-- `List the tokens available in Crush.`
-- `Show me the indicators and timeframes available in Crush.`
-- `Fetch OHLCV data for BTC.`
-### Backtests
-- `Create a simple moving-average crossover backtest.`
-- `Validate this entry expression before backtesting it.`
-- `List my recent backtests.`
-### Strategies
-- `Show my current live strategies.`
-- `Get the logs for my latest strategy.`
-- `Create a strategy from my best completed backtest.`
-### Intelligence
-- `Show me the latest alpha for SOL.`
-- `Get token info for HYPE.`
-- `What are the trending tokens today?`
-## Authentication
-Crush stores OAuth credentials in `~/.crush-mcp/` and reuses them across supported MCP hosts.
-If tools appear in your AI host but calls fail with an auth error, run:
-```sh
-npx -y @crush-protocol/mcp-client login
-```
-After login, retry the same request in your MCP host. Token refresh is automatic when possible.
-## Useful Commands
+## Common Commands
 ```sh
-# Setup and auth
 npx -y @crush-protocol/mcp-client setup --all
 npx -y @crush-protocol/mcp-client login
 npx -y @crush-protocol/mcp-client auth:status
 npx -y @crush-protocol/mcp-client doctor
-# Connectivity and discovery
 npx -y @crush-protocol/mcp-client ping
 npx -y @crush-protocol/mcp-client tools:list
-# Backtests
-npx -y @crush-protocol/mcp-client backtest:schema
-npx -y @crush-protocol/mcp-client backtest:list --limit 10
 ```
 ## Troubleshooting
@@ -560,20 +105,6 @@ npx -y @crush-protocol/mcp-client backtest:list --limit 10
 | Tools appear but fail with auth errors | Run `npx -y @crush-protocol/mcp-client login` |
 | Crush was working before but now fails | Run `npx -y @crush-protocol/mcp-client doctor` |
 | You want to confirm local auth state | Run `npx -y @crush-protocol/mcp-client auth:status` |
-| You want a fast connectivity check | Run `npx -y @crush-protocol/mcp-client doctor` |
-| You want to verify end-to-end reachability | Run `npx -y @crush-protocol/mcp-client ping` |
-## How It Works
-```text
-AI host -> @crush-protocol/mcp-client -> Crush hosted MCP
-```
-The npm package runs as a local stdio MCP process. It loads cached OAuth credentials, connects to the hosted Crush MCP over authenticated HTTP, and forwards tool calls to the server.
-## GitHub Activity
-[![Star History Chart](https://api.star-history.com/svg?repos=crush-protocol/crush-mcp-server&type=Date)](https://star-history.com/#crush-protocol/crush-mcp-server&Date)
 ## License

package/dist/cli.js CHANGED Viewed

File without changes

package/package.json CHANGED Viewed

@@ -1,68 +1,69 @@
 {
-  "name": "@crush-protocol/mcp-client",
-  "version": "0.4.4",
-  "description": "Official Crush MCP client for hosted market data, backtests, and trading workflows",
-  "type": "module",
-  "license": "MIT",
-  "homepage": "https://github.com/crush-protocol/crush-mcp-server/tree/main/packages/crush-mcp-client#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/crush-protocol/crush-mcp-server.git",
-    "directory": "packages/crush-mcp-client"
-  },
-  "bugs": {
-    "url": "https://github.com/crush-protocol/crush-mcp-server/issues"
-  },
-  "keywords": [
-    "crush",
-    "crush-protocol",
-    "mcp",
-    "model-context-protocol",
-    "trading",
-    "backtest",
-    "quant",
-    "cursor",
-    "claude-code",
-    "codex"
-  ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "bin": {
-    "crush-mcp-client": "dist/cli.js"
-  },
-  "files": [
-    "dist",
-    "INSTRUCTIONS.md"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
-  },
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.26.0",
-    "dotenv": "^17.2.1",
-    "zod": "^3.25.76",
-    "@crush-protocol/mcp-contracts": "0.1.2"
-  },
-  "devDependencies": {
-    "@types/node": "^24.3.0",
-    "dotenv-cli": "^8.0.0",
-    "tsx": "^4.20.4",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "scripts": {
-    "build": "rm -rf dist && tsc -p tsconfig.json",
-    "dev": "tsx src/cli.ts",
-    "test": "vitest run",
-    "test:e2e": "dotenv -e .env.e2e vitest run src/__tests__/e2e.test.ts"
-  }
-}
+	"name": "@crush-protocol/mcp-client",
+	"version": "0.4.6",
+	"description": "Official Crush MCP client for hosted market data, backtests, and trading workflows",
+	"type": "module",
+	"license": "MIT",
+	"homepage": "https://github.com/crush-protocol/crush-mcp-server/tree/main/packages/crush-mcp-client#readme",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/crush-protocol/crush-mcp-server.git",
+		"directory": "packages/crush-mcp-client"
+	},
+	"bugs": {
+		"url": "https://github.com/crush-protocol/crush-mcp-server/issues"
+	},
+	"keywords": [
+		"crush",
+		"crush-protocol",
+		"mcp",
+		"model-context-protocol",
+		"trading",
+		"backtest",
+		"quant",
+		"cursor",
+		"claude-code",
+		"codex"
+	],
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"bin": {
+		"crush-mcp-client": "dist/cli.js"
+	},
+	"files": [
+		"dist",
+		"INSTRUCTIONS.md"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		}
+	},
+	"scripts": {
+		"build": "rm -rf dist && tsc -p tsconfig.json",
+		"dev": "tsx src/cli.ts",
+		"test": "vitest run",
+		"test:e2e": "dotenv -e .env.e2e vitest run src/__tests__/e2e.test.ts",
+		"prepublishOnly": "pnpm run build"
+	},
+	"dependencies": {
+		"@crush-protocol/mcp-contracts": "workspace:*",
+		"@modelcontextprotocol/sdk": "^1.26.0",
+		"dotenv": "^17.2.1",
+		"zod": "^3.25.76"
+	},
+	"devDependencies": {
+		"@types/node": "^24.3.0",
+		"dotenv-cli": "^8.0.0",
+		"tsx": "^4.20.4",
+		"typescript": "^5.9.2",
+		"vitest": "^3.2.4"
+	},
+	"engines": {
+		"node": ">=20"
+	}
+}

package/LICENSE DELETED Viewed

@@ -1,21 +0,0 @@
-MIT License
-Copyright (c) 2025 Edwin Hernandez
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.