Skip to main content
Glama
bykarantelicom

bykaranteli-mcp

by bykarantelicom
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

LiqMap: estimated liquidation clusters with real prints overlaid

get_liqmap
Read-only

Retrieve modeled liquidation levels and real liquidation prints for a perpetual symbol to identify where leveraged longs or shorts would be liquidated.

Instructions

Call this when the user asks where liquidation clusters or liquidity pools sit for a perpetual, where leveraged longs/shorts would get liquidated, or for a liquidation heatmap reading. Returns the LiqMap snapshot for one symbol: modeled liquidation levels by price, zone aggregates and real liquidation prints from every liquidation venue ByKaranteli counts (listed on bykaranteli.com/coverage). Without an account key (or on the Free plan) the 24h view; with a Builder or higher key (BYKARANTELI_API_KEY) every timeframe from 1h to 30d.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
symbolNoSymbol like BTCUSDT (bare BTC accepted). Default BTCUSDT.
timeframeNoModel window. Default 24h, the only one served without a Builder or higher key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.27.2
    • addedInput schema / properties / timeframe
      Added value: +{
+  "description": "Model window. Default 24h, the only one served without a Builder or higher key.",
+  "enum": [
+    "1h",
+    "4h",
+    "12h",
+    "24h",
+    "3d",
+    "1w",
+    "30d"
+  ],
+  "type": "string"
+}
  2. Addedv0.9.0

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnlyHint and openWorldHint annotations, the description discloses the one-symbol scope, the exact return components (modeled levels by price, zone aggregates, real prints), and the account-key-based timeframe limitation. This materially informs the agent about behavior that annotations alone would not convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the usage trigger, follows with the return contents, and ends with plan/tier constraints. Every sentence earns its place; there is no filler or repetition of schema fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter read-only tool, the description covers trigger intent, return contents, symbol scope, and auth-gated timeframes. Without an output schema, a bit more detail about response shape would strengthen completeness, but nothing needed to invoke the tool correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so baseline is 3. The description adds context that timeframe availability depends on API key tier and that the tool serves one symbol, but it does not add significant meaning beyond the schema's own parameter descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource: 'Call this when the user asks where liquidation clusters or liquidity pools sit...' and details the returns as modeled liquidation levels by price, zone aggregates, and real liquidation prints. This clearly distinguishes it from siblings like get_liquidations and get_liquidation_cascades by emphasizing the LiqMap heatmap and venue-counted real prints.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit trigger conditions ('Call this when the user asks where liquidation clusters...') and explains key-tier access constraints affecting which timeframe is served. It does not explicitly name sibling alternatives to exclude, but the trigger framing is strong enough to guide selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools