Skip to main content
Glama
Sign In

Vike Data API

by io.vike
OverviewDiscussionsAdmin

Perp Open Interest

perp_open_interest
Read-onlyIdempotent

Open interest of one perpetual-futures symbol on each venue Vike polls: aster, binance, bitget, bybit, hyperliquid, kucoin, okx. oi_usd is USD NOTIONAL (open contracts x mark price when polled), not contracts or coins. Without hours: the newest print per venue and its age in seconds; venues printed within the last hour, stale_venues went silent (last print within 30 days) and must NOT be summed in. With hours (1-168): an hourly series per venue, the last print in each UTC hour. Venues are polled roughly every 5-8 minutes. symbol is the canonical base asset ('BTC', not 'BTCUSDT'). A symbol no venue lists returns empty lists and a note, never zeros.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "symbol": "<symbol>"
    },
    "name": "perp_open_interest"
  }
}

Input Schema

NameRequiredDescriptionDefault
hoursNoOmit for the latest print per venue. 1 to 168 for an hourly series over that many hours.
symbolYesRequired. Base asset, e.g. 'BTC', 'ETH', 'SOL' (not 'BTCUSDT').
exchangeNoOnly this venue (lower case), e.g. 'binance'. Omit for every venue.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds substantial context beyond them: polling cadence of roughly 5-8 minutes per venue, how staleness is defined (last print within 30 days), that `oi_usd` is notional rather than contracts, and that an unlisted symbol returns empty lists plus a note instead of zeros.

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?

Dense and front-loaded: the resource and unit caveat come first, then the two modes, then edge-case behavior. Every sentence carries information, though the venue enumeration and output-field naming make it slightly crowded for a mid-length description.

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?

There is no output schema, so the description must carry the return shape, and it does: per-venue `oi_usd`, print age in seconds, `venues` vs `stale_venues`, hourly series semantics, and the empty-result contract. Nothing needed to call or interpret the response 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?

Schema coverage is 100%, so the baseline is 3, but the description earns more by clarifying that the hourly series takes the last print in each UTC hour (not an average) and that `symbol` is a canonical base asset. `exchange` is only implied via the venue list and never called out by name, which keeps it from a 5.

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?

States a specific resource (open interest of one perpetual-futures symbol) and an explicit scope (every venue Vike polls, enumerated by name). The metric is inherently distinct from the sibling perp_funding, perp_long_short, and perp_spreads tools, so an agent can select it without opening another 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?

Clearly splits the two usage modes: omit `hours` for the newest print per venue, supply 1-168 for an hourly series. It also gives a hard exclusion ('stale_venues ... must NOT be summed in') and the canonical-symbol requirement. It stops short of naming an alternative tool for adjacent metrics, so it lands at 4 rather than 5.

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

All Vike Data API toolsInspect
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