XCREENER README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the XCREENER listing page.
@xcreener/mcp
Local stdio MCP bridge for XCREENER's XQL screener API — validate, explain, and run XQL queries from Claude Desktop, Cursor, Windsurf, or any stdio MCP client.
About XCREENER
XCREENER is a market screener that scans Crypto, Forex, Indices, Commodities, and Metals simultaneously, so you don't have to check charts one at a time. It's built for beginner traders through ready-made screeners as well as for developers and AI agents, who can express custom conditions in XCREENER Query Language (XQL) and run them instantly via a REST API or MCP. Learn more at xcreener.com.
What this MCP server does
This package is the local stdio bridge to XCREENER's XQL API specifically. It exposes xql_validate, xql_explain, xql_run, and xql_nl_reference as MCP tools, so any stdio MCP client can check and execute XQL screens against live market data without you writing any HTTP glue code.
Installation
Claude Desktop (.mcpb)
Download the latest xcreener.mcpb from this repo's Releases page, then double-click it to install — Desktop asks for your API key in a masked field as part of that same dialog. No JSON to hand-edit, no separate Node install.
Other MCP clients (npx)
Add this to your client's MCP server config (e.g. Cursor, Windsurf, Claude Code):
From source
Then point your client at node dist/index.js with XCREENER_API_KEY set in its environment.
Configuration
| Variable | Required | Description |
|---|---|---|
XCREENER_API_KEY | Yes | Your XCREENER API key, from xcreener.com/account/api-key. |
The key is checked lazily — an invalid or missing key won't stop the server from starting, it'll just surface as an auth error the first time a tool is called.
Available tools
| Name | Type | Description |
|---|---|---|
xql_validate | Tool | Validate XQL query text by parsing and planning it, without executing it against live data. |
xql_explain | Tool | Parse and plan an XQL query, returning its execution plan and a human-readable explanation. |
xql_run | Tool | Parse, plan, and execute an XQL query against live market data, returning matching instruments. |
xql_nl_reference | Tool | Reference document mapping natural-language trading phrases to XQL syntax. |
Example session
Under the hood, the assistant calls the xql_nl_reference tool, translates your plain-English ask into an XQL query, and calls xql_validate/xql_run — what you see is just the human-visible conversation. A few real examples:
Multi-market screen
You: check all markets and see which instruments are oversold at the moment
XCREENER runs (same query per market —
CRYPTO,FOREX,INDICES,METALS,COMMODITIES):XCREENER: Oversold (RSI(14) < 30, hourly) across all markets:
Market Symbol RSI(14) Crypto BTCUSDT 26.3 Crypto ETHUSDT 27.5 Crypto XRPUSDT 28.0 Commodities WHEATUSD 21.0 Commodities CORNUSD 22.6 Forex, Indices, and Metals had no oversold matches.
Single-market snapshot
You: can you give me updates on how the metals are doing?
XCREENER runs:
XCREENER: Metals snapshot, hourly:
Symbol Close 1h ROC RSI(14) Trend (vs SMA50) XPTUSD (Platinum) 1,637.98 +0.03% 54.8 Uptrend XAGUSD (Silver) 57.48 +0.02% 38.6 Downtrend XAUUSD (Gold) 4,043.69 +0.01% 41.0 Downtrend Overall: fairly quiet, no oversold/overbought extremes (all RSI 38–55). Platinum's the strongest — up-trending with the best momentum — while gold and silver are drifting below their 50-hour average.
Cross-pair aggregate analysis
You: which currency is the weakest and strongest?
XCREENER runs:
XCREENER: Based on the 1h ROC across all 28 pairs (aggregating each currency's average move against the other seven):
Rank Currency Avg 1h Strength 1 (strongest) CHF +0.0414% 2 JPY +0.0184% ... 8 (weakest) USD -0.0421% Strongest: CHF — up against every other major this hour. Weakest: USD — sold broadly against EUR, GBP, AUD, JPY, and CHF alike.
Actionable trade plan
You: NZD looks like the strongest currency this week — which pair should I long based on that, and what stop-loss/take-profit levels make sense?
XCREENER runs:
XCREENER: Idea: Long NZDUSD — the cleanest multi-timeframe confluence: NZD is the #2 strongest currency of the week, daily is non-conflicting, and hourly shows an uptrend (close 0.5881 > SMA(50) 0.5846) with bullish-but-not-overbought momentum (RSI(14) 60.8).
Level Rationale Entry ~0.5881 Current price Stop Loss 0.5845 Below the 20h swing low and h1 SMA(50); ~3× ATR(14) TP1 0.5940 ~1.6:1 R:R, partial scale-out TP2 0.6093 Weekly 52-week high, ~5.9:1 R:R Not financial advice — a technical read off the pulled data; confirm against execution/spread costs before entering.
Development
The build produces a single bundled ESM file (dist/index.js) with all dependencies inlined via tsup, so both the npm package and the .mcpb bundle ship without node_modules.
License
MIT — see LICENSE.