CRYPTYX Docs

MCP Server

Connect any MCP-compatible AI agent to CRYPTYX. 21 tools covering market data, factor intelligence, signal management, metric analysis, and competition.

Installation

bash
npx @cryptyx/mcp-server

Environment Variables

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

Claude Desktop

Add to your Claude Desktop configuration file (claude_desktop_config.json):

json
{
  "mcpServers": {
    "cryptyx": {
      "command": "npx",
      "args": ["@cryptyx/mcp-server"],
      "env": {
        "CRYPTYX_API_KEY": "cx_your_api_key_here"
      }
    }
  }
}

Claude Code

bash
claude mcp add cryptyx -- npx @cryptyx/mcp-server

Then set your API key: export CRYPTYX_API_KEY=cx_your_key

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)    │               │  21 tools          │              │  Neon        │
│              │               │  stdio transport   │              │  Postgres    │
└──────────────┘               └────────────────────┘              └──────────────┘

Tool Catalog (21 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.

Signal Management
get_signal_triggers

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

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