Skip to main content
Glama
Sign In

Okx

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Perp Metrics

perp_metrics
Read-onlyIdempotent

Crypto perpetual futures snapshot in one call: funding rate, open interest, taker buy/sell volume (CVD) and long/short account ratio for a perpetual swap. Accepts exchange-style symbols such as 'MASKUSDT', 'MASK' or 'MASK-USDT-SWAP'. Figures come from the OKX venue and the response states that venue, so a symbol quoted on Binance or Bybit is answered with OKX's own contract for that coin, labelled as such.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "instId": "MASKUSDT",
      "buckets": 6
    },
    "name": "perp_metrics"
  }
}

Input Schema

NameRequiredDescriptionDefault
instIdYesPerpetual symbol — 'MASKUSDT', 'MASK', 'MASK-USDT' and 'MASK-USDT-SWAP' all resolve to the same OKX contract.
periodNoBucket size for taker flow and long/short ratio: 5m, 15m, 30m, 1H, 2H, 4H, 6H, 12H, 1D. Default 5m.
bucketsNoHow many recent buckets of taker flow to sum for CVD. Default 24, max 100.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already mark this as read-only, idempotent, and non-destructive, so the description doesn't need to repeat safety cues. It adds valuable behavioral context beyond the annotations: data comes from OKX, the response labels the venue, and symbol variants resolve to the same contract. This meaningfully informs an agent about cross-venue behavior.

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 compact and front-loaded with the core purpose, then covers symbol flexibility and venue behavior in two additional sentences. Every sentence earns its place without redundant phrasing or filler.

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?

For a read-only data snapshot with no output schema, the description adequately covers what the tool returns, how symbols are interpreted, and the venue caveat. The schema covers remaining parameter details, so an agent has what it needs to select and invoke the tool correctly.

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?

The input schema covers 100% of parameters with detailed descriptions, including defaults, allowed values, and symbol normalization examples. The tool description adds no parameter-specific semantics beyond the schema, so the baseline of 3 is appropriate.

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 action—taking a 'snapshot in one call'—and lists the exact metrics included (funding rate, open interest, taker buy/sell volume/CVD, long/short ratio). It also differentiates this combined tool from the individual metric sibling tools by emphasizing that all data comes in a single call.

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?

The description makes the use case clear: when an agent needs multiple perp metrics at once, this tool is the one-call option. It also provides important venue guidance by explaining that OKX is the data source and that non-OKX symbols are resolved to OKX contracts, which helps avoid incorrect assumptions about venue.

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

All Okx 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