@aicoin/aicoin-mcp 1.0.0

package/README.md

@@ -0,0 +1,140 @@
+# @aicoin/mcp
+
+Unified AiCoin MCP Server — crypto market data + trading in one package.
+
+Merges `@aicoin/opendata-mcp` (market data via AiCoin API) and `@aicoin/trade-mcp` (trading via CCXT) into **41 tools**.
+
+## Quick Start
+
+```json
+{
+  "mcpServers": {
+    "aicoin": {
+      "command": "npx",
+      "args": ["-y", "@aicoin/mcp"],
+      "env": {
+        "AICOIN_ACCESS_KEY_ID": "<your opendata key>",
+        "AICOIN_ACCESS_SECRET": "<your opendata secret>",
+        "DEFAULT_EXCHANGE": "binance",
+        "BINANCE_API_KEY": "<your key>",
+        "BINANCE_SECRET": "<your secret>",
+        "USE_PROXY": "false"
+      }
+    }
+  }
+}
+```
+
+## Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `AICOIN_ACCESS_KEY_ID` | No | AiCoin OpenData API key (free tier built-in) |
+| `AICOIN_ACCESS_SECRET` | No | AiCoin OpenData API secret |
+| `DEFAULT_EXCHANGE` | No | Default exchange for trading (default: binance) |
+| `{EXCHANGE}_API_KEY` | For trading | Exchange API key |
+| `{EXCHANGE}_SECRET` | For trading | Exchange API secret |
+| `{EXCHANGE}_PASSPHRASE` | OKX/Bitget | Exchange passphrase |
+| `USE_PROXY` | No | Enable proxy (true/false) |
+| `PROXY_URL` | No | Proxy URL (http/https/socks5) |
+
+Supported exchanges: `binance`, `binanceusdm`, `binancecoinm`, `okx`, `bybit`, `bitget`, `gate`, `huobi`, `hyperliquid`
+
+## Tools (41)
+
+### Trade (11) — CCXT-based exchange trading
+
+| # | Tool | Description |
+|---|------|-------------|
+| 1 | `exchange_info` | List exchanges, query trading pairs. Actions: `exchanges`, `markets` |
+| 2 | `exchange_ticker` | Real-time ticker (single or batch) |
+| 3 | `exchange_market_data` | Order book, trades, OHLCV. Actions: `orderbook`, `trades`, `ohlcv` |
+| 4 | `exchange_funding` | Funding rates. Actions: `current`, `history` |
+| 5 | `account_status` | Account balance & positions. Actions: `balance`, `positions` |
+| 6 | `account_orders` | Order queries. Actions: `open`, `closed`, `by_id`, `my_trades` |
+| 7 | `account_history` | Account history. Actions: `ledger`, `deposits`, `withdrawals` |
+| 8 | `create_order` | Place market/limit orders |
+| 9 | `cancel_order` | Cancel single or all orders |
+| 10 | `set_trading_config` | Set leverage & margin mode. Actions: `leverage`, `margin_mode` |
+| 11 | `transfer` | Transfer funds between accounts |
+
+### Coins (5) — AiCoin coin data
+
+| # | Tool | Description |
+|---|------|-------------|
+| 12 | `coin_info` | Coin data. Actions: `list`, `ticker`, `config`, `ai_analysis` |
+| 13 | `coin_funding_rate` | Funding rate history (regular or volume-weighted) |
+| 14 | `coin_liquidation` | Liquidation data. Actions: `map`, `history`, `estimated` |
+| 15 | `coin_open_interest` | Aggregated OI history (stablecoin or coin-margined) |
+| 16 | `coin_futures_data` | Futures depth & trades. Actions: `historical_depth`, `super_depth`, `trade_data` |
+
+### Contents (2) — News & flash
+
+| # | Tool | Description |
+|---|------|-------------|
+| 17 | `news` | News articles. Actions: `list`, `detail`, `rss` |
+| 18 | `flash` | Flash news. Actions: `newsflash`, `list`, `exchange_listing` |
+
+### Markets (6) — Market & index data
+
+| # | Tool | Description |
+|---|------|-------------|
+| 19 | `market_info` | Exchange/market data. Actions: `exchanges`, `ticker`, `hot_coins`, `futures_interest` |
+| 20 | `kline` | K-line data. Actions: `data`, `indicator`, `trading_pair` |
+| 21 | `index_data` | Index data. Actions: `price`, `info`, `list` |
+| 22 | `crypto_stock` | Crypto stocks. Actions: `quotes`, `top_gainer`, `company` |
+| 23 | `coin_treasury` | Corporate holdings. Actions: `entities`, `history`, `accumulated`, `latest_entities`, `latest_history`, `summary` |
+| 24 | `depth` | Order book depth. Actions: `latest`, `full`, `grouped` |
+
+### Features (5) — Signals & analytics
+
+| # | Tool | Description |
+|---|------|-------------|
+| 25 | `market_overview` | Market overview. Actions: `nav`, `ls_ratio`, `liquidation`, `grayscale_trust`, `gray_scale`, `stock_market` |
+| 26 | `order_flow` | Order flow. Actions: `big_orders`, `agg_trades` |
+| 27 | `trading_pair` | Trading pairs. Actions: `ticker`, `by_market`, `list` |
+| 28 | `signal_data` | Signal data. Actions: `strategy`, `alert`, `config`, `alert_list`, `change` |
+| 29 | `signal_manage` | Manage alerts. Actions: `add`, `delete` |
+
+### Hyperliquid (11) — HL-specific analytics
+
+| # | Tool | Description |
+|---|------|-------------|
+| 30 | `hl_ticker` | HL tickers (single coin or batch) |
+| 31 | `hl_whale` | Whale data. Actions: `positions`, `events`, `directions`, `history_ratio` |
+| 32 | `hl_liquidation` | Liquidation data. Actions: `history`, `stats`, `stats_by_coin`, `top_positions` |
+| 33 | `hl_open_interest` | OI data. Actions: `summary`, `top_coins`, `history` |
+| 34 | `hl_taker` | Taker data. Actions: `delta`, `klines` |
+| 35 | `hl_trader` | Trader analytics. Actions: `stats`, `best_trades`, `performance`, `completed_trades`, `accounts`, `statistics` |
+| 36 | `hl_fills` | Trade fills. Actions: `by_address`, `by_oid`, `by_twapid`, `top_trades` |
+| 37 | `hl_orders` | Orders. Actions: `latest`, `by_oid`, `filled`, `filled_by_oid`, `top_open`, `active_stats`, `twap_states` |
+| 38 | `hl_position` | Position data. Actions: `current_history`, `completed_history`, `current_pnl`, `completed_pnl`, `current_executions`, `completed_executions` |
+| 39 | `hl_portfolio` | Portfolio data. Actions: `portfolio`, `pnls`, `max_drawdown`, `net_flow` |
+| 40 | `hl_advanced` | Advanced. Actions: `info`, `smart_find`, `discover` |
+
+### Guide (1)
+
+| # | Tool | Description |
+|---|------|-------------|
+| 41 | `guide` | Setup guides. Actions: `api_key`, `upgrade`, `trade_setup` |
+
+## Testing
+
+```bash
+npm run build
+node test-tools.mjs            # Test all tools
+node test-tools.mjs hl_         # Test Hyperliquid only
+node test-tools.mjs coin        # Test coin-related only
+```
+
+## Development
+
+```bash
+npm run dev    # Watch mode
+npm run build  # Production build
+npm start      # Run server
+```
+
+## License
+
+MIT