Skip to main content
Glama
OKX Market Guard

OKX Market Guard

by mavis-codee

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
HTTPS_PROXYNoProxy URL (e.g. http://127.0.0.1:7890) used when the network cannot resolve www.okx.com directly. Requires NODE_USE_ENV_PROXY=1.
NODE_USE_ENV_PROXYNoSet to "1" to make Node use the proxy environment variables. Only read at Node bootstrap, so it must be set before the process starts.

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

okx-market-guard exposes OKX PUBLIC market data only (ticker, candles, funding rate, open interest, and stateless threshold checks). Every tool is read-only. This server has no API key, cannot place or cancel orders, and cannot access account or wallet data. Spot instrument IDs look like BTC-USDT; perpetuals look like BTC-USDT-SWAP.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": false
}

Tools

Functions exposed to the LLM to take actions

NameDescription
market_tickerA

Get the latest OKX public ticker for one instrument (spot or swap). READ-ONLY: this tool only calls OKX public market REST. No API key, no order, no account access. Example instId: BTC-USDT or BTC-USDT-SWAP.

market_candlesA

Get recent OKX public candlesticks (OHLCV) for one instrument. READ-ONLY: this tool only calls OKX public market REST. No API key, no order, no account access. Returns newest-first, same as OKX. bar examples: 1m, 5m, 1H, 1D.

funding_rateA

Get the current OKX public funding rate for a perpetual swap. READ-ONLY: this tool only calls OKX public market REST. No API key, no order, no account access. instId must be a SWAP, e.g. BTC-USDT-SWAP.

oi_summaryA

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.

alert_checkA

Evaluate a one-shot threshold against the latest OKX public market data. No persistent alerts, no notifications, no writes. READ-ONLY: this tool only calls OKX public market REST. No API key, no order, no account access. Metrics last/high24h/low24h/changePercent24h/bidAskSpreadPct use the ticker; fundingRate needs a -SWAP instId; openInterest needs SWAP or FUTURES.

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

TDQS

A3.9/5.0

Scored across 5 tools

Disambiguation4/5

Each tool maps to a distinct market data primitive: ticker, candles, funding rate, open interest, and a composite threshold check. The only soft overlap is alert_check, which can evaluate metrics already exposed by market_ticker/funding_rate/oi_summary, but its one-shot evaluation framing keeps it separable.

Naming Consistency4/5

All names are lowercase snake_case and consistently noun/resource-oriented (market_ticker, market_candles, funding_rate, oi_summary, alert_check). Minor deviation: the market_ prefix appears on only two of five tools, and oi_ is an abbreviation where others spell things out.

Tool Count5/5

Five tools is well-scoped for a read-only market monitoring surface, with each tool covering a distinct data need. Nothing feels padded or redundant.

Completeness4/5

Covers the core monitoring set (price, OHLCV, funding, OI, threshold alerts) for spot and swaps. Gaps remain: no instrument/symbol discovery tool (agent must already know instIds), and no order book depth, mark/index price, or recent trades, which are common for a 'market guard' use case.

Maintenance

ActivityMaintained
ResponsivenessNo recent community issues