Skip to main content
Glama

LiqMap: estimated liquidation clusters with real prints overlaid

get_liqmap
Read-only

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. Covers the crypto perps and the stock and commodity perps: gold is XAU, silver XAG, WTI crude oil CL, Brent BZ, natural gas NATGAS, copper COPPER, platinum XPT, palladium XPD, stocks their ticker (TSLA, NVDA). 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). On the Free plan the 24h view; on Builder and higher plans every timeframe from 1h to 30d. By default the 30 real levels nearest the price and the 30 largest real prints; pass detail "full" for all of them. Pass detail "compact" for a shorter page or "full" for the whole answer.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_liqmap"
  }
}

Input Schema

NameRequiredDescriptionDefault
detailNoOptional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page.
symbolNoSymbol like BTCUSDT (bare BTC accepted). Commodity perps use the contract code: XAU gold, XAG silver, CL WTI crude, BZ Brent, NATGAS, COPPER, XPT platinum, XPD palladium; stocks their ticker (TSLA). Default BTCUSDT.
timeframeNoModel window. Default 24h, the only one on the Free plan; Builder and higher plans get every window.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / symbol / description
      Previous value: -"Symbol like BTCUSDT (bare BTC accepted). Default BTCUSDT."New value: +"Symbol like BTCUSDT (bare BTC accepted). Commodity perps use the contract code: XAU gold, XAG silver, CL WTI crude, BZ Brent, NATGAS, COPPER, XPT platinum, XPD palladium; stocks their ticker (TSLA). Default BTCUSDT."
  2. Changed3 schema fields changed
    • addedInput schema / properties / detail / anyOf
      Added value: +[
      +  {
      +    "type": "boolean"
      +  },
      +  {
      +    "enum": [
      +      "compact",
      +      "full"
      +    ],
      +    "type": "string"
      +  }
      +]
    • changedInput schema / properties / detail / description
      Previous value: -"Optional. true: every real level and every real print (default false: the 30 nearest levels, the 30 newest prints)."New value: +"Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
    • removedInput schema / properties / detail / type
      Removed value: -"boolean"
  3. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  4. Changed2 schema fields changed
    • addedInput schema / properties / detail
      Added value: +{
      +  "description": "Optional. true: every real level and every real print (default false: the 30 nearest levels, the 30 newest prints).",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / timeframe / description
      Previous value: -"Model window. Default 24h, the only one served without a Builder or higher key."New value: +"Model window. Default 24h, the only one on the Free plan; Builder and higher plans get every window."
  5. Changed1 schema field changed
    • 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"
      +}
  6. Changed1 schema field changed
    • addedInput schema / properties / symbol / description
      Added value: +"Symbol like BTCUSDT (bare BTC accepted). Default BTCUSDT."
  7. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already mark this read-only and open-world. The description adds plan gating (Free 24h only; Builder+ all timeframes), default truncation to 30 real levels and 30 largest prints, and the detail options, which materially affects how the agent should call it.

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

Conciseness4/5

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

The trigger sentence is front-loaded and the rest is organized around assets, return shape, plan limits, and detail. Some symbol-to-contract mappings are repeated from the schema, so it is not maximally tight.

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

Completeness5/5

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

No output schema exists, but the description explains the snapshot components, coverage source, plan-dependent timeframes, and default row limits. An agent has enough to call it correctly for selection and output expectations.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3. The description adds the default 30-level/30-print truncation and clarifies that 'full' returns all, going beyond the schema's detail description, though the symbol and timeframe notes largely duplicate the schema.

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 states a specific verb ('Returns the LiqMap snapshot') and resource (modeled liquidation levels, zone aggregates, real prints) and scopes it to one symbol, distinguishing it from raw liquidation tools like get_liquidations. It also lists supported asset classes, so an agent can tell what it covers without opening the schema.

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 opens with explicit trigger scenarios: where liquidation clusters sit, where longs/shorts would liquidate, or a heatmap reading. It does not name alternative sibling tools (e.g., get_liquidations for raw prints) or state when not to use it, so the guidance is clear but not exhaustive.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.