@crush-protocol/mcp-client 0.4.18 → 0.4.20

package/INSTRUCTIONS.md

@@ -45,26 +45,42 @@ After login, credentials are cached locally and reused across supported hosts.
 
 ### 📈 Market Data (ClickHouse)
 
-| Tool                    | Purpose                                                                      |
-| ----------------------- | ---------------------------------------------------------------------------- |
-| `list_tables`           | List all ClickHouse tables with descriptions.                                |
-| `list_tokens`           | List available trading pairs in the data warehouse.                          |
-| `list_indicators`       | List pre-computed indicators with categories.                                |
-| `list_timeframes`       | List available data timeframes.                                              |
-| `get_data_range`        | Get earliest/latest date for a token + timeframe.                            |
-| `check_query_size`      | Estimate row count before fetching. **Call this before large queries.**      |
-| `fetch_ohlcv`           | Fetch OHLCV candlestick data (row cap: 5000).                                |
-| `fetch_indicator`       | Fetch pre-computed indicator values (row cap: 5000).                         |
-| `get_connection_config` | Get read-only ClickHouse credentials for local processing of large datasets. |
-
-### 🧮 Custom Indicators
-
-| Tool                      | Purpose                               |
-| ------------------------- | ------------------------------------- |
-| `save_custom_indicator`   | Save a custom indicator formula.      |
-| `list_custom_indicators`  | List user's saved indicator formulas. |
-| `get_custom_indicator`    | Retrieve a formula by name.           |
-| `delete_custom_indicator` | Delete a formula by name.             |
+| Tool                                | Purpose                                                              |
+| ----------------------------------- | -------------------------------------------------------------------- |
+| `crush_ch_list_tables`              | List all available tables with descriptions and row counts.          |
+| `crush_ch_describe_table`           | Get column definitions, types, and comments for a table.             |
+| `crush_ch_data_freshness`           | Check data freshness for all tables.                                 |
+| `crush_ch_list_indicators`          | List pre-computed indicators with categories.                        |
+| `crush_ch_find_data`                | Search data catalog by concept (e.g. "funding rate", "BTC price").   |
+| `crush_ch_query_market_ohlcv`       | Query OHLCV, OI, funding, liquidation data (row cap: 5000).         |
+| `crush_ch_query_derivatives`        | Query derivatives data with interval filter.                         |
+| `crush_ch_query_global_metrics`     | Query global market metrics or per-coin derivatives metrics.         |
+| `crush_ch_query_token_market_info`  | Query market snapshot data (32 coins, hourly).                       |
+| `crush_ch_query_hyperliquid_ws`     | Query real-time 1m candles (229 perps).                              |
+| `crush_ch_query_exchange_data`      | Query unified exchange data (futures + spot).                        |
+| `crush_ch_query_sentiment`          | Query sentiment consensus data.                                      |
+| `crush_ch_search_twitter`           | Search collected tweets by keyword, author, engagement.              |
+| `crush_ch_search_news_feeds`        | Search aggregated news with sentiment and token filters.             |
+| `crush_ch_query_token_list`         | Query token snapshots (price, market cap, supply, unlock info).      |
+| `crush_ch_query_unlock_events`      | Query token unlock schedules.                                        |
+| `crush_ch_run_query`                | Run custom read-only SQL (SELECT only, row cap: 5000).               |
+
+### 📉 Liquidation & Risk
+
+| Tool                                   | Purpose                                                       |
+| -------------------------------------- | ------------------------------------------------------------- |
+| `crush_ch_query_liq_coin_summary`      | Per-coin liquidation volume/count by time window.              |
+| `crush_ch_query_liq_maxpain`           | Max Pain risk scores and critical liquidation price levels.    |
+| `crush_ch_query_liq_exchange`          | Liquidation distribution across exchanges.                    |
+| `crush_ch_query_liq_history`           | Historical liquidation volume time series.                    |
+| `crush_ch_query_liq_heatmap_snapshot`  | Liquidation heatmap aggregated by price level.                |
+| `crush_ch_query_liq_whale_positions`   | Whale positions with liquidation prices.                      |
+| `crush_ext_fear_greed_index`           | Fear & Greed Index with BTC price history.                    |
+| `crush_ext_bitcoin_active_addresses`   | Bitcoin daily active address count.                           |
+| `crush_ext_liq_heatmap`               | Real-time liquidation heatmap.                                |
+| `crush_ext_liq_maxpain`               | Real-time Max Pain risk scores for all coins.                 |
+| `crush_ext_liq_coin_snapshot`          | Real-time per-coin liquidation snapshot.                      |
+| `crush_ext_liq_whale_positions`        | Real-time whale positions on-chain.                           |
 
 ### ⚙️ Strategy Management
 
@@ -78,11 +94,11 @@ After login, credentials are cached locally and reused across supported hosts.
 | `toggle_strategy`   | Activate or deactivate live trading.              |
 | `get_strategy_logs` | Get execution logs for a strategy.                |
 
-### 💰 Trading (Hyperliquid)
+### 💰 Trading
 
 | Tool               | Purpose                                                  |
 | ------------------ | -------------------------------------------------------- |
-| `place_order`      | Place a market or limit order on Hyperliquid perpetuals. |
+| `place_order`      | Place a market or limit order on perpetuals.             |
 | `get_positions`    | Get current open positions.                              |
 | `get_account_info` | Get account balance, margin, and PnL.                    |
 | `get_portfolio`    | Get all balances across chains.                          |
@@ -96,7 +112,6 @@ After login, credentials are cached locally and reused across supported hosts.
 | `get_trending_tokens` | Get trending tokens on a given chain.                  |
 | `get_alpha_feed`      | Get recent alpha posts from Twitter and communities.   |
 | `get_token_feed`      | Get token-specific news and events.                    |
-| `fetch_news`          | Fetch news and intel feeds with keyword/token filters. |
 
 ---
 
@@ -119,11 +134,11 @@ After login, credentials are cached locally and reused across supported hosts.
 ### Market Research
 
 ```
-1. list_tokens / search_tokens  → Find tokens of interest
-2. get_data_range               → Check data availability
-3. check_query_size             → Estimate dataset size
-4. fetch_ohlcv / fetch_indicator → Fetch data (≤5000 rows)
-   └─ If too large: get_connection_config → write Python script for local processing
+1. crush_ch_list_tables / crush_ch_find_data  → Discover available data
+2. crush_ch_list_indicators                   → Browse indicator catalog
+3. crush_ch_query_market_ohlcv                → Fetch OHLCV data (≤5000 rows)
+4. crush_ch_query_global_metrics              → Check market-wide metrics
+5. crush_ch_run_query                         → Custom SQL for complex analysis
 ```
 
 ### Go Live
@@ -141,8 +156,8 @@ After login, credentials are cached locally and reused across supported hosts.
 ## Important Rules
 
 1. **Backtest is async**: `create_backtest` returns immediately. Refresh with `list_backtests` until status is `COMPLETED` or `FAILED`. Typical wait: 30s–3min.
-2. **Data row caps**: `fetch_ohlcv` and `fetch_indicator` have a 5000 row limit. For larger datasets, use `get_connection_config` and process locally.
+2. **Data row caps**: All ClickHouse query tools have a 5000 row limit. Use narrower time ranges or filters to stay within the cap.
 3. **Always validate first**: Call `validate_expression` before using an expression in `create_backtest` to catch errors early.
 4. **Signal discovery order**: Always call `get_signal_metadata` → `get_signals_by_category` before building expressions. Don't guess signal IDs.
 5. **Strategy lifecycle**: Backtest → Create Strategy → Toggle Active. A strategy must be deactivated before deletion.
-6. **Trading is real**: `place_order` executes real trades on Hyperliquid. Always confirm with the user before placing orders.
+6. **Trading is real**: `place_order` executes real trades. Always confirm with the user before placing orders.

package/README.md

@@ -217,7 +217,7 @@ npx -y @crush-protocol/mcp-client setup --windsurf
 npx -y @crush-protocol/mcp-client setup --claude-desktop
 ```
 
-**Manual config:** Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
+**Manual config:** Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
 
 ```json
 {
@@ -271,7 +271,7 @@ npx -y @crush-protocol/mcp-client setup --opencode
 npx -y @crush-protocol/mcp-client setup --warp
 ```
 
-**Manual config:** Go to `Warp Drive` → `MCP Servers` → `+ Add`, then paste:
+**Manual config:** Add via Warp Drive → MCP Servers → `+ Add`:
 
 ```json
 {
@@ -312,7 +312,7 @@ Add to `~/.kiro/settings/mcp.json` (global) or `.kiro/settings/mcp.json` (worksp
 <details>
 <summary><strong>Roo Code</strong></summary>
 
-Open Roo Code settings → `Edit Global MCP`. Or add to `.roo/mcp.json` (project):
+Add to `.roo/mcp.json` (project) or open Roo Code settings → Edit Global MCP:
 
 ```json
 {
@@ -332,7 +332,7 @@ Open Roo Code settings → `Edit Global MCP`. Or add to `.roo/mcp.json` (project
 <details>
 <summary><strong>Cline</strong></summary>
 
-Open Cline panel → MCP Servers → `Configure MCP Servers` to edit `cline_mcp_settings.json`:
+Add to `cline_mcp_settings.json` (open via Cline panel → MCP Servers → Configure MCP Servers):
 
 ```json
 {
@@ -352,7 +352,7 @@ Open Cline panel → MCP Servers → `Configure MCP Servers` to edit `cline_mcp_
 <details>
 <summary><strong>Trae</strong></summary>
 
-Trae → Settings → MCP → `Add MCP Server`:
+Add via Trae → Settings → MCP → Add MCP Server:
 
 ```json
 {
@@ -372,7 +372,7 @@ Trae → Settings → MCP → `Add MCP Server`:
 <details>
 <summary><strong>Augment Code</strong></summary>
 
-Hamburger menu → Settings → Tools → `+ Add MCP` → Command: `npx -y @crush-protocol/mcp-client`
+Add via Settings → Tools → `+ Add MCP` → Command: `npx -y @crush-protocol/mcp-client`
 
 ```json
 "augment.advanced": {
@@ -487,7 +487,7 @@ Add to `~/.config/zed/settings.json`:
 <details>
 <summary><strong>JetBrains AI Assistant</strong></summary>
 
-Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`
+Add via Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`:
 
 ```json
 {
@@ -527,7 +527,7 @@ Settings → Tools → AI Assistant → Model Context Protocol (MCP) → `+ Add`
 <details>
 <summary><strong>LM Studio</strong></summary>
 
-Program → Install → Edit `mcp.json`:
+Add to `mcp.json` (open via Program → Install → Edit mcp.json):
 
 ```json
 {
@@ -588,7 +588,7 @@ Add to `.mcp/mcp.json` in your solution directory:
 <details>
 <summary><strong>Perplexity Desktop</strong></summary>
 
-Perplexity → Settings → Connectors → Add Connector → Advanced → Server Name: `crush-protocol`
+Add via Perplexity → Settings → Connectors → Add Connector → Advanced. Server Name: `crush-protocol`
 
 ```json
 {
@@ -623,7 +623,7 @@ Perplexity → Settings → Connectors → Add Connector → Advanced → Server
 <details>
 <summary><strong>Zencoder</strong></summary>
 
-Zencoder menu → Agent tools → Add custom MCP:
+Add via Zencoder menu → Agent tools → Add custom MCP:
 
 ```json
 {

package/dist/mcp/proxy.js

@@ -13,35 +13,26 @@
 import { Server } from "@modelcontextprotocol/sdk/server/index.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { CallToolRequestSchema, ListToolsRequestSchema, PingRequestSchema } from "@modelcontextprotocol/sdk/types.js";
-import { getPreflightStatusMessage } from "./authPreflight.js";
 import { OAuthRemoteMcpClient } from "./oauthRemoteClient.js";
 import { getCachedAuthStatus } from "./oauthStorage.js";
 import { CLIENT_NAME, CLIENT_VERSION } from "./version.js";
 export async function runProxy(serverUrl) {
-    const authStatus = await getCachedAuthStatus(serverUrl);
-    if (authStatus.status === "not_authenticated") {
-        const message = getPreflightStatusMessage({
-            authStatus,
-            requiresManualLogin: true,
-            canAutoRefreshLogin: false,
-        });
-        process.stderr.write(`${message ?? "Crush needs sign-in on this machine."}\n`);
-        process.exit(1);
-    }
-    const preflightMessage = getPreflightStatusMessage({
-        authStatus,
-        requiresManualLogin: false,
-        canAutoRefreshLogin: true,
-    });
-    if (preflightMessage) {
-        process.stderr.write(`${preflightMessage}\n\n`);
-    }
     const remoteClient = new OAuthRemoteMcpClient({
         serverUrl,
         oauth: {
             authorizationOutput: "stderr",
         },
     });
+    const authStatus = await getCachedAuthStatus(serverUrl);
+    if (authStatus.status === "not_authenticated") {
+        process.stderr.write("[crush] Sign-in required. Opening browser...\n");
+        process.stderr.write("[crush] If the browser does not open, use the URL printed below.\n");
+        await remoteClient.ensureAuthorized();
+        process.stderr.write("[crush] Sign-in complete.\n\n");
+    }
+    else if (authStatus.status === "registered") {
+        process.stderr.write("[crush] Refreshing credentials...\n");
+    }
     await remoteClient.connect();
     const remoteTools = await remoteClient.listTools();
     const localServer = new Server({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crush-protocol/mcp-client",
-  "version": "0.4.18",
+  "version": "0.4.20",
   "description": "Official Crush MCP client for hosted market data, backtests, and trading workflows",
   "type": "module",
   "license": "MIT",
@@ -47,7 +47,7 @@
     "@modelcontextprotocol/sdk": "^1.26.0",
     "dotenv": "^17.2.1",
     "zod": "^3.25.76",
-    "@crush-protocol/mcp-contracts": "0.1.2"
+    "@crush-protocol/mcp-contracts": "0.1.3"
   },
   "devDependencies": {
     "@types/node": "^24.3.0",