Skip to main content
Glama

Hyperliquid Liquidation Heatmap – Crypto Trading – by HyperPerps

Heatmap field definitions

get_heatmap_field_definitions
Read-only

Definitions of every field in the liquidation heatmap: conventions, cluster shape, field glossary, query options, supported markets and refresh cadence. Generated from the live API documentation.

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_heatmap_field_definitions"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so the read-only, closed scope is known. The description adds that the content is generated from live API documentation and that it covers refresh cadence, but it says nothing about format, size, or how the reference relates to live query results.

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 definition is a single front-loaded sentence that names the resource first and then lists its contents compactly. The list is dense but every item is informative, so nothing is wasted.

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 zero-parameter reference tool with no output schema, the description is appropriately complete: it tells the agent exactly which topics the definitions cover. Only a direct pointer to the companion heatmap tool is missing.

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?

The tool takes no parameters and the schema is an empty object, so there is nothing to clarify at the parameter level. The baseline for a zero-parameter tool applies.

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

Purpose4/5

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

The description names a specific resource, the field definitions for the liquidation heatmap, and enumerates the contents: conventions, cluster shape, field glossary, query options, supported markets, and refresh cadence. That is enough to distinguish it from the sibling data tool get_liquidation_heatmap, though the description never explicitly points to that alternative.

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

Usage Guidelines3/5

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

The doc resource's purpose implies it should be consulted to interpret the heatmap output, but the description gives no explicit when-to-use or when-not-to-use guidance. It never names get_liquidation_heatmap as the retrieval alternative, so the agent has to work out the division of labor from the sibling's name alone.

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.