whale-data

Market overview + regime

market_overview

Read-onlyIdempotent

One-call market scan: totals (volume, OI, liquidations, mcap), 24h whale net flow, BTC risk regime (SMA20/50 + breadth), and the top rows by volume. Pass coin to get one symbol's row directly (no paging needed). Descriptive market data only.

Input Schema

TableJSON Schema

Name	Required	Description
`coin`	No	Return this coin's row on its own, for example BTC, instead of the whole board. Only coins in the streamed overview (roughly the top 300 by volume) are there; anything else comes back available:false rather than as an empty board.
`pair`	No	Alias for coin.
`limit`	No	Max board rows returned. Defaults to 20, hard ceiling 50 for everyone and no plan raises it. total_rows reports the size of the whole board so a shortened list is visible. Ignored when coin is passed, since that returns a single row.

Output Schema

TableJSON Schema

Name	Required	Description
`row`	No	That one symbol row: base, price_usd, chg_24h_pct, vol_usd_24h and oi_usd.
`coin`	No	The symbol asked for, when a single row was requested.
`note`	No	One line saying what the numbers cover, or why there are none. Read it before reporting any zero as a market reading.
`rows`	No	The board, ranked by volume: base symbol, price, 24h change, 24h volume and open interest.
`capped`	No	Present only when an argument was cut down to a ceiling. Absent means nothing was clamped, so a smaller number than you asked for is the data and not a limit.
`regime`	No	The Bitcoin risk state: state, btc_price and breadth_pct. A null state means the field is absent, not neutral.
`totals`	No	Market-wide totals: volume, open interest, forced closes and market cap.
`summary`	No	The answer in one plain sentence, computed from the fields below. Open the reply with this, then let the numbers back it up. Null only when there was nothing to summarise.
`returned`	No	How many rows are in this reply.
`available`	No	False when this lane could not answer: a producer is dark, the pair sits outside this plan, or the argument named something we do not carry. Absent or true means the numbers are a real reading, not a guess.
`truncated`	No	True when more rows matched than were returned, so what you have is a page and not the whole set.
`total_rows`	No	How many rows the whole board holds.
`updated_at`	No	When the snapshot was published.
`access_note`	No	What this connection could not return and what lifts it. Always pass this on to the user: it is the only place that information appears.
`coverage_note`	No	The same in one sentence, present only when something is missing.
`whale_net_usd_24h`	No	Buys minus sells across the board over 24h. Null means the field is absent from this snapshot, not that flow was balanced.
`unavailable_fields`	No	Fields this snapshot is not carrying. They are null because the field is absent, NOT because the value is zero.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedAug 31, 2026

addedOutput schema / properties / summary

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The answer in one plain sentence, computed from the fields below. Open the reply with this, then let the numbers back it up. Null only when there was nothing to summarise."
+}

Changed3 schema fields changedAug 13, 2026

addedInput schema / properties / coin / description

Added value: +"Return this coin's row on its own, for example BTC, instead of the whole board. Only coins in the streamed overview (roughly the top 300 by volume) are there; anything else comes back available:false rather than as an empty board."

addedInput schema / properties / limit / description

Added value: +"Max board rows returned. Defaults to 20, hard ceiling 50 for everyone and no plan raises it. total_rows reports the size of the whole board so a shortened list is visible. Ignored when coin is passed, since that returns a single row."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "access_note": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "What this connection could not return and what lifts it. Always pass this on to the user: it is the only place that information appears."
+    },
+    "available": {
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "False when this lane could not answer: a producer is dark, the pair sits outside this plan, or the argument named something we do not carry. Absent or true means the numbers are a real reading, not a guess."
+    },
+    "capped": {
+      "anyOf": [
+        {
+          "additionalProperties": false,
+          "properties": {
+            "applied": {
+              "description": "The value actually used.",
+              "type": "number"
+            },
+            "argument": {
+              "description": "Which argument was cut down, for example limit or hours.",
+              "type": "string"
+            },
+            "by": {
+              "description": "Why it was cut: keyless for the free ceiling, plan_max for a paid ceiling, tool_max for a ceiling no plan raises.",
+              "type": "string"
+            },
+            "max": {
+              "description": "The ceiling that applied.",
+              "type": "number"
+            },
+            "requested": {
+              "description": "The value the caller asked for.",
+              "type": "number"
+            }
+          },
+          "required": [
+            "argument",
+            "requested",
+            "applied",
+            "max",
+            "by"
+          ],
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Present only when an argument was cut down to a ceiling. Absent means nothing was clamped, so a smaller number than you asked for is the data and not a limit."
+    },
+    "coin": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The symbol asked for, when a single row was requested."
+    },
+    "coverage_note": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The same in one sentence, present only when something is missing."
+    },
+    "note": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "One line saying what the numbers cover, or why there are none. Read it before reporting any zero as a market reading."
+    },
+    "regime": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The Bitcoin risk state: state, btc_price and breadth_pct. A null state means the field is absent, not neutral."
+    },
+    "returned": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "How many rows are in this reply."
+    },
+    "row": {
+      "anyOf": [
+        {
+          "additionalProperties": {},
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "That one symbol row: base, price_usd, chg_24h_pct, vol_usd_24h and oi_usd."
+    },
+    "rows": {
+      "anyOf": [
+        {
+          "items": {},
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The board, ranked by volume: base symbol, price, 24h change, 24h volume and open interest."
+    },
+    "total_rows": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "How many rows the whole board holds."
+    },
+    "totals": {
+      "description": "Market-wide totals: volume, open interest, forced closes and market cap."
+    },
+    "truncated": {
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "True when more rows matched than were returned, so what you have is a page and not the whole set."
+    },
+    "unavailable_fields": {
+      "anyOf": [
+        {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Fields this snapshot is not carrying. They are null because the field is absent, NOT because the value is zero."
+    },
+    "updated_at": {
+      "anyOf": [
+        {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            }
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "When the snapshot was published."
+    },
+    "whale_net_usd_24h": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Buys minus sells across the board over 24h. Null means the field is absent from this snapshot, not that flow was balanced."
+    }
+  },
+  "type": "object"
+}

First observedAug 13, 2026

TDQS

A3.6/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds a useful behavioral note with 'Descriptive market data only' and implies no side effects, but it does not disclose pagination nuances or the available:false fallback, which are only in the schema.

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?

Two tight sentences cover the tool's data scope, the single-row mode, and the non-mutating nature. Every clause earns its place, and the most important information is front-loaded.

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 read-only overview tool with no required parameters and a full output schema, the description is nearly sufficient: it explains the purpose, the optional coin shortcut, and that data is descriptive. The only notable gap is lack of explicit guidance on when to prefer this tool over sibling overview-style tools.

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 the schema already documents coin, pair, and limit thoroughly. The description reinforces the coin behavior and 'no paging needed,' but adds little meaning beyond what the input schema provides.

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 states a specific action ('One-call market scan') and enumerates distinct resources: totals, whale net flow, BTC risk regime, and top rows by volume. This makes the tool's purpose clear, though it does not explicitly contrast itself with close siblings like market_snapshot or market_digest.

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?

It gives clear context for the default board and a direct instruction for the coin parameter ('Pass coin to get one symbol's row directly'). It does not, however, say when to choose this tool over its many siblings or when not to use it.

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

All whale-data tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?