CRYPTYX Docs

MCP Server & CLI

Connect any MCP-compatible AI agent to CRYPTYX — institutional-grade digital asset intelligence exposed as 30 tools covering signals, factor scores, backtests, regime, and venue-neutral execution references.

Install (30 seconds)

Paste this URL into your MCP client's custom-connector flow. OAuth handles auth — no API keys, no config file editing, revocable per-app.

url
https://mcp.cryptyx.ai/api/mcp

Full step-by-step for Claude.ai, Cursor, and other clients at cryptyx.ai/mcp. On first connect you'll be redirected to a CRYPTYX consent screen — grant the scopes you want (read / trigger / execute) and you're live.

Suggested starter prompts

Paste any of these into your agent after connecting. Each hits a different capability and returns institutional-grade evidence with health grades and the exchange-handshake execution pointer.

Grounding

Show me today's top 5 CRYPTYX signals ranked by 7-day information coefficient. Flag any that are red-graded on walk-forward reliability.

Regime

What macro regime is the crypto market in right now? Include tactical (7d/14d) vs strategic (30d/60d) alignment — flag any transition.

Backtest

Backtest the treasury_manager_classic trigger on ETH over the past 180 days. Include Sharpe, Sortino, max drawdown, and profit factor. Is it institutionally actionable?

Per-asset conviction

For BTC, give me the top-conviction composite signal that fired today. Include factor evidence and walk-forward reliability grade — and if actionable, point me at the reference execution code.

Divergences

Which asset outside BTC/ETH has the strongest divergence pattern today? Include severity, the two factor classes involved, and interpretation.

Custom trigger

Evaluate a custom composite trigger on SOL: TR_ROC_7D abs_gt 1.5 AND VOL_RV_7D lt 1.0. Return the 5-year backtest evidence envelope.

Environment variables (legacy stdio only)

The OAuth path above needs no env vars. These apply only to the legacy stdio server (see "Legacy install" below).

VariableRequiredDescription
CRYPTYX_API_KEYYesYour CRYPTYX API key (cx_* prefix)
CRYPTYX_API_URLNoOverride base URL (default: https://cryptyx.ai)

Legacy install — stdio server (deprecated 2026-12-31)

For clients that don't yet support OAuth MCP (older Cursor releases, some enterprise agent platforms). Existing cx_* API keys keep working indefinitely — no forced migration.

Claude Desktop (JSON config)
json
{
  "mcpServers": {
    "cryptyx": {
      "command": "npx",
      "args": ["-y", "@cryptyx/mcp-server"],
      "env": {
        "CRYPTYX_API_KEY": "cx_your_api_key_here"
      }
    }
  }
}
Claude Code (CLI install)
bash
claude mcp add cryptyx -- npx -y @cryptyx/mcp-server

Then: export CRYPTYX_API_KEY=cx_your_key

Direct HTTP with API key (mcp-remote bridge)
text
Endpoint:  https://mcp.cryptyx.ai/api/mcp
Transport: Streamable HTTP (JSON-RPC 2.0 over POST)
Auth:      Authorization: Bearer cx_your_key

Same 30 tools as the OAuth path. Use this if you want HTTP without OAuth — API-key auth still supported alongside OAuth on the same endpoint.

CLI (Terminal)

The same package ships a human-facing CLI. All 30 tools are available as terminal commands with table formatting, colored output, and JSON export.

bash
# Install globally (or use npx cryptyx)
npm install -g @cryptyx/mcp-server

# Save your API key
cryptyx config set-key cx_your_api_key

# Full state snapshot
cryptyx snapshot

# Factor scores for an asset
cryptyx factors BTC

# Top signals by information coefficient
cryptyx signals top

# Backtest a signal
cryptyx signals backtest TR_MOMO_CONT_14D --from 2025-04-20 --to 2026-04-20

# Raw JSON output (pipe to jq, scripts, cron)
cryptyx market --json

Run cryptyx --help for the full command list. Every command supports --json, --api-key, and --api-url flags.

Programmatic (TypeScript)

typescript
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

const transport = new StdioClientTransport({
  command: "npx",
  args: ["@cryptyx/mcp-server"],
  env: { CRYPTYX_API_KEY: process.env.CRYPTYX_API_KEY! },
});

const client = new Client({ name: "my-agent", version: "1.0.0" });
await client.connect(transport);

// List available tools
const { tools } = await client.listTools();
console.log(tools.map(t => t.name));

// Call a tool
const result = await client.callTool({
  name: "get_market_snapshot",
  arguments: { assets: "BTC,ETH,SOL" },
});
console.log(result.content);

Architecture

text
┌──────────────┐     stdio      ┌────────────────────┐    HTTPS     ┌──────────────┐
│              │ ◄──────────► │                    │ ──────────► │              │
│  AI Agent    │               │  @cryptyx/         │              │  CRYPTYX     │
│  (Claude,    │  MCP Protocol │  mcp-server        │  REST API    │  REST API    │
│   LangChain, │               │                    │              │              │
│   custom)    │               │  30 tools          │              │  Neon        │
│              │               │  stdio transport   │              │  Postgres    │
└──────────────┘               └────────────────────┘              └──────────────┘

Tool Catalog (30 tools)

Market Data
get_market_snapshot

Asset universe with composite scores, returns, volatility, and rankings.

params: assets?, mode?, days?

get_market_pulse

Factor breadth and regime analysis across the entire asset universe.

params: days?, horizons?, classes?

get_price_history

Daily OHLCV candle data for backtesting and charting.

params: asset (required), days?

search_assets

List all tracked assets in the CRYPTYX universe with universe tags.

get_live_prices

Latest spot prices for all tracked assets (refreshed every 15 minutes).

get_asset_liquidity

Order book depth — bid/ask USD at 50/100/200bp from mid.

params: asset (required), days?

Factor Intelligence
get_factor_scores

Factor t-scores for an asset across 8 classes (CORR, EFF, FLOW, FUT, OB, OPT, TR, VOL) and multiple horizons.

params: asset (required), mode?, days?, horizons?

get_composite_rankings

Full state snapshot: factor breadth, top/bottom rankings, signal summary, pipeline status.

get_regime_analysis

Regime classification (trending, mean-reverting, volatile) with primary and secondary regime confidence.

params: asset (required), mode?, days?

get_featured_metrics

Top-performing metrics by information coefficient (IC). Returns the 8 highest-conviction metrics with A/B grades.

get_macro_regime

Market-wide macro regime classification across all horizons. Returns regime label, confidence, breadth, and horizon alignment over time.

params: days?, horizon?

get_divergences

Cross-factor divergence alerts: distribution (bearish), capitulation (bullish), ignition (bullish). Detects when factor classes disagree — early warning of regime shifts.

params: horizons?

Signal Management
get_signal_triggers

Today's active signal firings across all assets with confidence scores. Atomic and composite.

get_top_signals

Curated top 10 signals ranked by 7d information coefficient (IC). Pre-filtered to A/B health grade with proven predictive power.

get_signal_catalog

All signals with active parameters and 30-day trigger statistics.

get_signal_explanation

Structured explanation of why a signal fired (or didn't) for a specific asset/day.

params: signal_id (required), day (required), asset (required)

backtest_signal

Run a backtest over a date range. Returns per-day trigger counts and aggregate statistics.

params: signal_id (required), from (required), to (required), dryrun?

fork_signal

Create a new inactive parameter variant. Can be backtested without affecting the live signal.

params: signal_id (required), params (required)

simulate_signal

Estimate trigger rate if a threshold were changed. No actual changes made.

params: signal_id (required), threshold_key (required), threshold_value (required), asof_day?

Metric Analysis
analyze_metric

Single-metric z-score backtest with forward returns across 8 horizons. The core factor discovery tool.

params: metric_id (required), asset (required), operator (required), threshold (required)

scan_metric_universe

Scan a metric across all ~200 assets for z-score extremes on the latest day.

params: metric_id (required), operator (required), threshold (required)

analyze_metrics_composite

Multi-factor z-score intersection backtest. Define 2-4 conditions and see when ALL fire simultaneously.

params: asset (required), conditions (required)

Competition
get_competition_leaderboard

Ranked competition entries with Sharpe ratio, return, drawdown, and composite scores.

params: round_id?, sort_by?

get_competition_rounds

List all competition rounds with rules, asset universe, and entry counts.

Factor Classes

CodeNameDescription
CORRCorrelationCross-asset correlation dynamics
EFFEfficiencyMarket efficiency and mean reversion
FLOWFlowCapital flow and fund movement
FUTFuturesDerivatives positioning and sentiment
OBOrder BookDepth, imbalance, and microstructure
OPTOptionsImplied vol, skew, and term structure
TRTrendPrice momentum and trend strength
VOLVolatilityRealized and implied vol dynamics