bykaranteli-mcp 0.30.1 → 0.30.3

package/README.md

@@ -2,15 +2,26 @@
 
 MCP (Model Context Protocol) server for **live crypto derivatives data**: funding rates, cross-exchange funding arbitrage, open interest pressure, liquidations, options, ETF flows, Fear & Greed and BTC dominance.
 
-50 read-only tools over the public JSON API of [bykaranteli.com](https://bykaranteli.com/developers). Since 2026-09-10 the API asks programs for an account key: a **free key** comes with any verified account at <https://bykaranteli.com/dashboard/api> (30 requests a minute, public depth), and the Builder, Business and Scale plans raise the rate and unlock member depth (LiqMap on seven timeframes, 5-minute series, the x402 catalog included). Set it as `BYKARANTELI_API_KEY`. Data covers Binance USDT-M perpetuals; funding arbitrage, liquidations, order book depth, options, positioning and insurance funds add the other venues each board lists on bykaranteli.com/coverage.
+51 read-only tools over the public JSON API of [bykaranteli.com](https://bykaranteli.com/developers). Since 2026-09-10 the API asks programs for an account key: a **free key** comes with any verified account at <https://bykaranteli.com/dashboard/api> (30 requests a minute and 15,000 a month, public depth), and the Builder, Business and Scale plans raise the rate and the monthly fair use and unlock member depth (LiqMap on seven timeframes, 5-minute series, a monthly x402 catalog allowance). Set it as `BYKARANTELI_API_KEY`. Data covers Binance USDT-M perpetuals; funding arbitrage, liquidations, order book depth, options, positioning and insurance funds add the other venues each board lists on bykaranteli.com/coverage.
 
 ## Hosted endpoint (no install)
 
 Paste `https://mcp.bykaranteli.com` as a custom connector in any MCP-capable
-assistant. Same 50 tools, nothing to install. Without a key it runs on the
-shared Free pool; a connector header with your account key, `x-api-key: bk_...`
-(claude.ai custom connectors) or `Authorization: Bearer bk_...` (Builder and
-above), brings your own rate limit and member depth.
+assistant. Same 51 tools, nothing to install. Every tool call needs your
+account key (free at <https://bykaranteli.com/dashboard/api>); connecting and
+listing the tools work without one. The key travels one of three ways:
+
+- the request header `x-api-key: bk_...` (claude.ai custom connectors, Cursor,
+  Claude Code);
+- the request header `Authorization: Bearer bk_...`;
+- the address `https://mcp.bykaranteli.com/?key=bk_...` for clients that cannot
+  send headers (ChatGPT). Treat that address like a password and revoke the key
+  if it leaks.
+
+A free account covers the API and the hosted MCP on one monthly counter;
+Builder and above bring higher rates and member depth.
+
+Step-by-step guide for beginners: https://bykaranteli.com/guide/connect
 
 ## Quick start
 
@@ -89,6 +100,7 @@ Requires Node.js 18 or newer.
 | `get_coverage` | "Which exchanges are behind your liquidation totals? How fresh is the data?" |
 | `get_orderbook_depth` | "Where is the biggest BTC bid wall? How deep is ETH within 2% on Coinbase vs Binance?" |
 | `get_jupiter_perps` | "How much long vs short OI is on Jupiter SOL perps? Who topped Jupiter this week? What is the JLP APR?" |
+| `get_solana_perps` | "Which Solana perp DEX has the most open interest? What is Pacifica's BTC funding and 24h volume? Jupiter versus Pacifica?" |
 | `get_turkey_premium` | "What do lira buyers pay for bitcoin above the world price? What is the Turkey Premium Index and its score right now? Which Turkish exchange is dearest? What is USDT/TRY against the official rate?" |
 | `get_data_proof` | "Can I verify a ByKaranteli number was not changed later? Show the on-chain proof for BTC funding right now. Which Solana transaction sealed the newest epoch?" |
 | `get_cycle_indicators` | "Has the Pi Cycle crossed? Mayer Multiple and Puell today?" |
@@ -126,16 +138,23 @@ Server: MIT. Data: personal and research use with attribution "ByKaranteli (byka
 
 ## Plans and paid depth
 
-| Plan | Price | Rate | Depth |
-|---|---|---|---|
-| Free API | $0 | 30 / min | public pages |
-| Builder | $49 / mo | 300 / min | member depth, x402 catalog included |
-| Business | $149 / mo | 1,200 / min | member depth, commercial licence, monthly bulk |
-| Scale | $399 / mo | 3,000 / min | member depth, derived redistribution, daily raw |
+| Plan | Price | Rate | Monthly | Depth |
+|---|---|---|---|---|
+| Free API | $0 | 30 / min | 15,000 | public pages |
+| Terminal | $29 / mo | 60 / min | 150,000 | public pages |
+| Builder | $49 / mo | 300 / min | 1,000,000 fair use | member depth, 1,000 x402 catalog calls a month |
+| Business | $149 / mo | 1,200 / min | 3,000,000 fair use | member depth, commercial licence, 10,000 x402 catalog calls a month, monthly bulk |
+| Scale | $399 / mo | 3,000 / min | 10,000,000 fair use | member depth, derived redistribution, x402 catalog with no ceiling, daily raw |
+
+A Free or Terminal key past its monthly figure gets 429 until
+the month resets. A paid key past its fair use is never stopped: it answers at
+the Free rate (30 a minute) until the month resets, with `x-quota-state: slow`
+on every answer.
 
 Full table: <https://bykaranteli.com/developers#tiers>. For recorded history and
 raw records beyond the live snapshots, bykaranteli.com also exposes pay-per-call
 x402 endpoints for anonymous agents (USDC on Solana or Base, priced per call,
 no account): <https://bykaranteli.com/developers#x402> · machine catalog:
-<https://bykaranteli.com/api/x402>. Builder and higher keys call those routes
-unpaid within their plan limits.
+<https://bykaranteli.com/api/x402>. Builder keys call those routes unpaid up to
+1,000 calls a month, Business up to 10,000, Scale with no ceiling; past the
+allowance a key pays per call like an anonymous agent or moves up a plan.

package/dist/tools.js

@@ -1106,6 +1106,32 @@ export function registerByKaranteliTools(server, options) {
             return fail(err);
         }
     });
+    server.registerTool("get_solana_perps", {
+        title: "Solana Perps board: open interest, 24h volume and hourly rates across Solana perpetual venues (Jupiter, Pacifica)",
+        description: "Call this when the user asks about perpetuals on Solana as a whole, which Solana perp DEX has the most open interest or volume, Pacifica markets (funding, open interest, 24h volume, mark) or how Jupiter compares with an order-book venue. Returns every venue summed and every market largest first, refreshed every 10 minutes; a venue filter and hourly history of one Pacifica market (up to 30 days) are optional. Jupiter-only detail (long versus short, utilization, JLP, top traders) is get_jupiter_perps.",
+        inputSchema: {
+            venue: z.string().trim().toLowerCase().regex(/^(jupiter|pacifica)$/).optional().describe("Venue filter: jupiter or pacifica"),
+            symbol: z.string().trim().toUpperCase().regex(/^[A-Z0-9_.-]{1,24}$/).optional().describe("Pacifica market symbol for hourly history, e.g. SOL or BTC"),
+            history_days: z.number().int().min(1).max(30).optional().describe("Hourly history for the symbol, 1..30 days"),
+        },
+        annotations: READ_ONLY,
+    }, async ({ venue, symbol, history_days }) => {
+        try {
+            const q = new URLSearchParams();
+            if (venue)
+                q.set("venue", venue);
+            if (symbol)
+                q.set("symbol", symbol);
+            if (history_days)
+                q.set("days", String(history_days));
+            const qs = q.toString();
+            const path = `/api/public/solana-perps${qs ? `?${qs}` : ""}`;
+            return ok(withProvenance(await fetchJson(path), path));
+        }
+        catch (err) {
+            return fail(err);
+        }
+    });
     server.registerTool("get_coverage", {
         title: "Coverage registry: which venues and data types we collect, how, and how fresh",
         description: "Call this when the user asks which exchanges sit behind a ByKaranteli number, whether a feed is complete or sampled, since when a venue is collected, or how fresh the data is. Returns the live coverage registry: liquidation feeds per venue with kind and last record, snapshot feeds per venue and market, funding arbitrage legs, positioning sources, whale tape, spot minutes and the Hyperliquid whale scan with freshness. snapshots[].country is the jurisdiction only when the venue states one; it is null for most venues, so do not read null as unknown risk.",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bykaranteli-mcp",
-  "version": "0.30.1",
-  "description": "MCP server for live crypto derivatives data from bykaranteli.com: funding rates, funding arbitrage, open interest pressure, liquidations, options, ETF flows, Fear & Greed and BTC dominance. 50 read-only tools, free account key, paid depth via plans or x402.",
+  "version": "0.30.3",
+  "description": "MCP server for live crypto derivatives data from bykaranteli.com: funding rates, funding arbitrage, open interest pressure, liquidations, options, ETF flows, Fear & Greed and BTC dominance. 51 read-only tools, free account key, paid depth via plans or x402.",
   "type": "module",
   "bin": {
     "bykaranteli-mcp": "dist/index.js"