Skip to main content
Glama
OKX Market Guard

OKX Market Guard

by mavis-codee

Open interest summary

oi_summary
Read-onlyIdempotent

Fetches OKX public open interest for one instrument or aggregates it by instrument type and currency using read-only market data, with no API key or account access.

Instructions

Get OKX public open interest for one instrument, or aggregated by instType/ccy. READ-ONLY: this tool only calls OKX public market REST. No API key, no order, no account access. Provide instId (e.g. BTC-USDT-SWAP) or instType (SWAP/FUTURES) optionally with ccy.

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": "oi_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
ccyNoCurrency filter, e.g. BTC. Requires instType.
instIdNoInstrument ID, e.g. BTC-USDT-SWAP.
instTypeNoUse with optional ccy to list OI for a product type.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds value beyond that by naming the backend ('only calls OKX public market REST') and stating that no API key, no order and no account access is involved — an auth/impact detail the annotations do not convey. It stops short of rate-limit or response-shape context, which keeps it from a 5.

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?

Three short sentences, front-loaded with purpose before the safety note and then the parameter hint. 'No API key, no order, no account access' is slightly redundant against the READ-ONLY label, but it is cheap and reinforcing rather than wasteful.

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

Completeness3/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 is the only place return shape could be conveyed, yet it never says what an open-interest response contains (fields, units, timestamp, one row vs. many for the aggregated mode). For a simple read tool with fully-described inputs this is workable but leaves a real gap.

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 every parameter including the instType enum and the 'Requires instType' constraint on ccy is already documented. The description largely restates those examples (BTC-USDT-SWAP, SWAP/FUTURES) rather than adding semantics such as precedence when both instId and instType are supplied. Baseline 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?

States a specific verb and resource ('Get OKX public open interest') and pins the scope ('for one instrument, or aggregated by instType/ccy'). The resource is unambiguous relative to the listed siblings (funding_rate, market_candles, market_ticker, alert_check), so an agent can route on the name plus this sentence alone.

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?

Gives explicit invocation modes ('Provide instId ... or instType (SWAP/FUTURES) optionally with ccy'), which tells the agent which combinations are meaningful. It offers no when-not-to-use guidance, no mention of limits or when another market-data sibling would be preferable, so it lands at adequate-with-gaps rather than a 4.

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