> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sharpe.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP Server

> Connect AI agents and LLM clients to Sharpe crypto derivatives and market data via the Model Context Protocol.

The Sharpe MCP Server exposes 42 tools (39 endpoint tools + 3 composite workflows), 5 resources, and 2 prompts for crypto derivatives and market data via the Model Context Protocol. It connects AI agents in Claude Desktop, Claude Code, Cursor, and any MCP-compatible client to data across 35 funding-rate exchanges and the rest of the Sharpe API surface: funding rates, futures, arbitrage, screeners, narratives, ecosystems, memecoins, new listings, project dashboards, and more.

***

## API key required

Every tool needs an API key from a [paid plan](https://www.sharpe.ai/pricing), on the hosted endpoint and in the npm package. It is the
same key the REST API uses, and tool calls draw on the plan's monthly quota and per-minute limit (see
[Rate limits](https://docs.sharpe.ai/rate-limits.md)). A key without an active plan answers `expired_api_key`.

Subscribe at [/dashboard/billing](https://www.sharpe.ai/dashboard/billing), create the key at [/dashboard/api-keys](https://www.sharpe.ai/dashboard/api-keys),
then send it as an `Authorization: Bearer sk_live_...` header (hosted) or set `SHARPE_API_KEY` (npm). A client that
connects by URL alone signs in instead ([Sign in from a connector](#sign-in-from-a-connector)), and its calls use the
account's key.

The hosted endpoint answers a request that carries neither a key nor a sign-in with HTTP 401 and the sign-in
challenge. The npm package lists its tools, resources and prompts without a key; a tool call without one answers how
to get one.

***

## Installation

### Hosted endpoint (no install)

The same server is hosted at `https://www.sharpe.ai/api/mcp` over the
Streamable HTTP transport. Clients that take a URL connect with nothing to
install. Send your key as an `Authorization: Bearer sk_live_...` header: every
tool reads the authenticated `/v1` routes under your plan's limits. A JSON-RPC
batch carries at most 10 messages.

```bash Claude Code theme={null}
claude mcp add --transport http sharpe https://www.sharpe.ai/api/mcp \
  --header "Authorization: Bearer sk_live_your_key_here"
```

```json title="Cursor (.cursor/mcp.json)" theme={null}
{
  "mcpServers": {
    "sharpe": {
      "url": "https://www.sharpe.ai/api/mcp",
      "headers": { "Authorization": "Bearer sk_live_your_key_here" }
    }
  }
}
```

### Sign in from a connector

A client that connects by URL alone, such as a Claude.ai or ChatGPT custom
connector, needs no header: add `https://www.sharpe.ai/api/mcp` and the first
connection opens a Sharpe sign-in. Sign in with your email and approve access;
the connector's tool calls then run as your account's API key, under the same
plan, trial and limits as REST calls. Create the key first: a signed-in account
without one is answered with a link to create it.

### One-click install

* [Add to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=sharpe\&config=eyJ1cmwiOiJodHRwczovL3d3dy5zaGFycGUuYWkvYXBpL21jcCJ9)
* [Add to VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sharpe\&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fwww.sharpe.ai%2Fapi%2Fmcp%22%7D)

Both add the hosted server by its address. A client that supports MCP sign-in
then signs you in; otherwise add your key as the `Authorization: Bearer` header
in its MCP settings.

```bash Codex theme={null}
codex mcp add sharpe --url https://www.sharpe.ai/api/mcp --bearer-token-env-var SHARPE_API_KEY
```

```bash Gemini CLI theme={null}
gemini mcp add --transport http --header "Authorization: Bearer $SHARPE_API_KEY" sharpe https://www.sharpe.ai/api/mcp
```

### Agent skills

The [Sharpe skills](https://github.com/Sharpe-Labs/skills) teach an agent
which tool answers which question, how to report the data's freshness, and how
to set the server up. In Claude Code the plugin adds the hosted server and both
skills; it asks for your API key when it is enabled.

```bash Claude Code plugin theme={null}
/plugin marketplace add Sharpe-Labs/skills
/plugin install sharpe@sharpe
```

```bash Any agent that supports skills theme={null}
npx skills add Sharpe-Labs/skills
```

Agents that discover skills from a site read
[`/.well-known/agent-skills/index.json`](https://www.sharpe.ai/.well-known/agent-skills/index.json).

### npm package (stdio)

The published server is the npm package
`@sharpe-terminal/mcp-server`. `npx` downloads the current npm release and
runs it over stdio without a global install. It needs Node.js 20 or later.

```bash title="No install needed (recommended)" theme={null}
SHARPE_API_KEY=sk_live_your_key_here npx -y @sharpe-terminal/mcp-server
```

```bash Persistent npm install theme={null}
npm install --global @sharpe-terminal/mcp-server
sharpe-mcp
```

### Command line

Given arguments, the same package runs one command instead of the server: one command per endpoint tool, with the
tool's parameters as flags and the API's JSON answer on stdout. See the
[CLI section of Developer tools](https://docs.sharpe.ai/developer-tools.md#command-line-cli).

```bash One call from a shell theme={null}
SHARPE_API_KEY=sk_live_your_key_here npx @sharpe-terminal/mcp-server funding-rates --coin BTC --limit 5
```

***

## Configuration

### Claude Desktop

Add to your `claude_desktop_config.json`:

```json title="Recommended (npm)" theme={null}
{
  "mcpServers": {
    "sharpe": {
      "command": "npx",
      "args": ["-y", "@sharpe-terminal/mcp-server"],
      "env": {
        "SHARPE_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}
```

> [!NOTE]
>
> The `env` block is required. Without `SHARPE_API_KEY` the server still starts
> and lists its tools, and every tool call answers how to get a key.

### Claude Code

```bash Add to Claude Code theme={null}
claude mcp add sharpe --env SHARPE_API_KEY=sk_live_your_key_here -- npx -y @sharpe-terminal/mcp-server
```

### Cursor

Add to `.cursor/mcp.json`:

```json theme={null}
{
  "mcpServers": {
    "sharpe": {
      "command": "npx",
      "args": ["-y", "@sharpe-terminal/mcp-server"],
      "env": {
        "SHARPE_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}
```

***

## Tools

The server exposes 42 tools organized into 8 categories. All tools accept optional parameters with sensible defaults and return structured data.

### Tool behavior

All Sharpe MCP tools are read-only market-data calls. Tools advertise MCP annotations for `readOnlyHint`, `destructiveHint=false`, `idempotentHint`, and `openWorldHint` so compatible clients can classify them safely.

The 39 endpoint tools are generated from the API's contracts: each tool's name, description and parameters (types, enums, bounds, defaults) are the ones the API documents, and the npm server and the hosted endpoint serve the same definitions. An argument a tool does not take, or one outside its schema, is refused with every issue named (`Invalid arguments for get_funding_rates: "limit" must be >= 1`) rather than dropped. Both use the API's parameter names (`minOiUsd`).

An endpoint tool answers `structuredContent` of `{ "data": ..., "meta": ... }`, with `pagination` beside `data` when the answer is one page, and the same JSON as text for clients that read only the content array:

* `data` is the payload as the API served it: the `/v1` route's `data`.
* `pagination` is `{ cursor, has_more, total }`: pass `cursor` back to read the next page.
* `meta.as_of`, `stale_after`, `freshness_status` and `runtime_status` carry the freshness the API reported, and `meta.warnings` what it (or the client) could not do. Treat `freshness_status` `stale` or `unknown` and `runtime_status` `degraded` as caveats to state.

Where every recorded API answer passes a tool's result schema, `tools/list` declares it as the tool's `outputSchema` (JSON Schema 2020-12, the MCP default), and a validating client checks each result against it. The other endpoint tools answer the same shape without a declared schema until a recorded `/v1` answer proves theirs; `tools/list` shows which tools declare one.

Composite workflow tools return `{ "report": "..." }` in `structuredContent` plus the same formatted markdown in text content. A failed call returns `isError` with the reason as text.

Large list responses are capped at 200 rows, and a payload still over about 25,000 characters has its largest arrays halved until it fits. A time series ordered oldest first keeps its newest rows; every other list keeps its head, where the API puts its ranking. The payload keeps its shape; the cut is reported in `meta`: `truncated: true`, a `truncation_message`, and `truncated_fields`, which maps each cut field (by its path in `data`, e.g. `data.rows`) to `{ total, showing }`, plus `kept: "latest"` when the newest rows were the ones kept. Where a tool takes `limit` and `cursor`, page with them rather than relying on the notice.

### Composite tools

High-level tools that combine multiple API calls into a single consolidated response. Best for broad questions. Each report is composed and rendered on the server by its own endpoint (`/v1/coins/{coin}/analysis`, `/v1/briefing` and `/v1/opportunities`, see [Reports](https://docs.sharpe.ai/reports.md)), and the tool prints the endpoint's `report_md` as served, byte for byte. Every number a report prints is a field the API serves, the same value the web page and `/api/v1` give: rankings, floors, averages and APRs are request parameters and response fields, never recomputed. Each report ends with a **Data freshness** line naming the freshness of every answer it read (dataset, `as_of`, status, and `degraded` with the API's warnings when a read was degraded); a read that failed is named on a **Data gaps** line, and the call fails only when every read did.

#### `analyze_coin`

Single-coin analysis in one view. Best tool for "what's happening with BTC?" questions. It combines:

* the price-prediction score and every signal, matched in the coverage list by the asset the funding read resolved (`bitcoin` is BTC, `1000PEPE` is PEPE), else by exact ticker (a coin outside it says so rather than guessing a slug); the price is the prediction snapshot's, printed with its as-of (it refreshes on a 12-hour SLA);
* current funding for the coin's ten largest markets by open interest (`get_funding_rates` with `sort=-open_interest`): each market's `rate_8h`, `apr` and open interest as served, lot contracts included, labelled with its `rate_kind`: on most venues the rate is the estimate of the next payment, not yet charged; on Kraken, Crypto.com and Bitfinex it is the last settled rate;
* the coin's average and median funding across venues on the 8-hour basis (`summary=1`: the funding grid's Avg Rate, open-interest-weighted or its median, with the venues behind it), over those same rates, so estimates and last-settled rates mixed;
* the asset's open-interest total in USD notional, venue count and the 1h/24h change of that USD total, from its row on the global board (`get_global_overview`: every contract of the asset once, lots included, venues listed in `openInterestExcludedVenues` left out and named, MEXC today), printed beside the asset's 24h price change because USD open interest moves with price;
* the estimated dollar funding over the next 24 hours at current rates, for each row the settlement API returns for the coin, with its `rate_source`. The settlement read matches the ticker as written, so when the funding read holds contract spellings it does not (PEPE and KPEPE for `1000PEPE`, BTC for `bitcoin`), the report names them as not in the figure.

**coin** `string`

Coin ticker (e.g., `BTC`, `ETH`, `SOL`). Defaults to `BTC`.

#### `market_briefing`

Market briefing combining the market overview, top and worst narratives, funding rate highlights, and the estimated whole-market funding settlement. Best tool for "what's going on in crypto?" or morning briefings.

No parameters. Returns formatted text with market stats (BTC dominance, the tracker's `btc_market_share`), Fear and Greed, the API's narrative ranking by 24h change (`sort`, `top`, `bottom`: a narrative without a 24h change is never ranked), and the API's funding extremes (`get_funding_rates` with `extremes=3` and `min_oi_usd=1000000`): the highest (at or above zero) and lowest (below zero, so possibly none) markets by 8-hour-equivalent rate among fresh markets with a usable interval and at least \$1M of open interest, printed as APR with the 8h and raw rates and each venue's `rate_kind` (mostly the estimate of the next payment, not yet charged), plus the counts the API left out.

#### `find_opportunities`

Scans all exchanges for funding arbitrage, combining spot-perp basis trades and cross-exchange funding arb.

No parameters. Spot-perp rows come from the board with `minOiUsd=1000000` (perp legs with at least $1M of open interest, unknown fails) in the API's order, net APR first, each with its perp open interest, `executionStatus`, and a flag when `pairStatus` is not `eligible` or `fundingIsStale` is true; the report says how many of the board's rows are executable, and marks open interest on a venue the API leaves out of its cross-venue totals (MEXC today) as unverified, since the floor still counts it. Cross-exchange rows need at least $1M of open interest and 24h volume on both legs and keep the board's order (executable rows first by net APR, then indicative rows by net APR where they have one, else gross APR; `limit=10`); each prints its funding spread (`netFundingRate` per `intervalHours`) and its entry gap (`spreadRate`, the price gap paid to open both legs, negative = favourable). The funding summary is the API's market stats (`stats=1`): mean and open-interest-weighted funding APR over the fresh primary contract of every venue and asset, and the positive/negative counts.

***

### Derivatives tools

Granular derivatives data for funding rates and futures charts.

#### `get_funding_rates`

Perpetual funding rates across 35 funding-rate exchanges (Binance, Bybit, OKX, Gate.io,
Hyperliquid, Kraken, Aster, Lighter, edgeX, and more; read `sharpe://exchanges` for the
current list). Positive rate means longs pay shorts.

`rate` is a decimal fraction settled over that row's own `interval_hours` (1h, 2h, 4h, 8h
or 24h depending on venue and market). It is not a percent and never implicitly 8h: current
rows also carry `rate_8h` (`rate * 8 / interval_hours`) and `apr` (`rate * 8760 /
interval_hours`), `null` without a usable interval, so compare venues on those.

With `type='current'` the API can answer with aggregates instead of rows: `extremes`
(the highest markets by `rate_8h` among those at or above zero and the lowest among
those below zero, so either list can be empty), `stats` (the whole book's funding APR and
how many tracked venues are live) and `summary` (a coin's average and median funding across
venues, its open interest over every contract and its next settlement). With
`type='accumulated'`, `summary` answers per window the coin's median realised funding and
median APR over the venues whose history covers the window, and its carry spread APR (best
short venue minus best long venue).

`coin` names an asset: `PEPE` returns every PEPE contract, the `1000PEPE` and `KPEPE`
lot contracts included. Current and accumulated rows carry `asset_id`, `asset_symbol`,
`lot_multiplier`, `instrument_status` and `is_live` (`null` = unknown).

Accumulated rows carry each window's APR (`acc_apr_1d` … `acc_apr_1y`: the sum annualised
over the days of history behind it) and `coverage`: per window (`1d`, `7d`, `30d`, `90d`, `1y`), the
share of the span the contract was expected to settle in that its settlements cover
(`coverage_ratio`, `null` when it was not expected in the window at all), `complete` (at
least 90%), and whether it was listed or halted inside the window. Compare `acc_*` across
contracts only on complete windows that were neither listed nor halted inside the window: those sum fewer hours than the window.

**type** `string`

One of `current` (live snapshot), `accumulated` (cumulative over
7d/30d/90d/1y), or `history` (per-coin time-series). Defaults to `current`.

**coin** `string`

Coin ticker, lot spelling or full name (`BTC`, `PEPE`, `1000PEPE`, `kPEPE`,
`bitcoin`). Returns every contract of that asset, whatever its `base_coin`
spelling. Required when `type='history'`; optional for `current` and
`accumulated`, where the server filters rows to that asset before truncation.

**exchange** `string`

Filter to a single venue. Accepts the slug (`gate-io`), the display name as
returned in the `exchange` field (`Gate.io`), or the ccxt id.

**margin** `string`

Collateral convention: `linear` for quote-margined contracts, `inverse` for
coin-margined ones. Unfiltered by default.

**asset\_class** `string`

One of `crypto`, `equity`, `commodity`, `fx`, `index`. Unfiltered by default.
The funding book carries tokenized equity, commodity, index and FX perps
alongside crypto, because they trade on the same venues.

**days** `integer`

Lookback days for history mode. Range 1-1095. Defaults to `30`.

**limit** `integer`

Maximum rows per page, 1-5000. Page the full book with `limit` + `cursor`
rather than relying on the truncation notice.

**cursor** `string`

Opaque cursor from the previous response's `pagination.cursor`.

**sort** `string`

`type='current'` only: `open_interest` or `-open_interest` orders the rows by
their open interest (unknown last either way) before `limit`/`cursor`.

**extremes** `integer`

`type='current'` only, 1-100: answer with the N highest and N lowest markets by
`rate_8h` (`extremes.highest`, `extremes.lowest`) among fresh rows with a usable
interval: `highest` holds only rates at or above zero and `lowest` only rates below
zero, so either list can be shorter than N or empty. Also answers
`extremes.omitted` (`stale`, `no_interval`, `below_floor`). Returns an
object instead of rows; do not pass `limit`, `cursor` or `sort` with it.

**min\_oi\_usd** `number`

With `extremes` only: the open-interest floor in USD. Unknown open interest fails a
floor above 0.

**stats** `string`

`type='current'` only: `1` answers with `market.funding_apr_mean`,
`market.funding_apr_oi_weighted`, `market.positive` and `market.negative` for the
whole book. Cannot be combined with `coin`, `exchange`, `margin`, `asset_class`,
`limit`, `cursor` or `sort`.

**summary** `string`

`type='current'` with `coin` only: `1` answers with one `summary` entry per
`base_coin` spelling and asset class: `funding_avg_8h`, `funding_median_8h`,
`funding_method`, `funding_venues_used`, `funding_venues_stale`, `funding_all_stale`.

#### `get_funding_settlement`

Dollar value of funding actually paid at each settlement -- not just the rate -- and which side, longs or shorts, paid it. Every response carries both the per-coin row breakdown and a `totals` block (`net`/`long_paid`/`short_paid`) for the requested window and class, so "who paid funding today" reads directly from `totals` rather than being summed from a page of rows; `totals` always reflects the full requested class regardless of any `coin`/`exchange` filter on the rows.

`window=current` (the default) is the next 24 hours of funding at current rates -- each contract's forward rate × 24 / its own interval hours, priced live off open interest -- always estimated, never realised. `1d`/`3d`/`7d` are realised windows; one whose coverage is below 90% carries `partial: true` (`complete: false`) in its window value because its history is still accruing, not a completed total, and `halted_within_window: true` says a contract stopped settling inside the window (`listed_within_window` is always `null`: no listing time is known). Sign convention: `net = long_paid - short_paid`; positive means longs paid more than they received (a cost to longs), negative means shorts paid more. Both `long_paid` and `short_paid` are always non-negative. Missing is `null`, never `0`.

**window** `string`

One of `current`, `1d`, `3d`, `7d`. Defaults to `current`.

**class** `string`

One of `all`, `crypto`, `equity`, `commodity`, `fx`, `index` (one asset
class each, as on the funding board) or `rwa`, every non-crypto class at
once. Defaults to `all`. The five classes' totals, and `crypto` + `rwa`
totals, always equal the `all` totals.

**coin** `string`

Comma-separated base coin tickers (e.g. `BTC` or `BTC,ETH,SOL`). Unfiltered
by default.

**exchange** `string`

Filter rows to a single venue. Free-form and registry-driven; an
unresolvable value is rejected rather than silently returning an empty book.

**limit** `integer`

Maximum rows to return, 1-1000. Defaults to `100`.

**offset** `integer`

Zero-based row offset for pagination. Defaults to `0`.

**sort** `string`

Sort field for the selected `window`: `base_coin`, `net`, `long_paid`,
`short_paid` or `open_interest_usd`, prefixed with `-` for descending. A row
with no value for the field (an unpriced coin) sorts last either way.

**expand** `string`

`venues` adds each row's per-venue breakdown. Left out by default to keep the
payload small.

#### `get_global_overview`

The whole-market derivatives board in one call: total open interest with its
crypto-versus-RWA split, 24h liquidations, average Wilder RSI(14) across the top
100 crypto perps by market cap, the Altcoin Season Index, open interest by
asset class, and a ranked per-asset row table. Liquidations are crypto-only
because no RWA perp venue publishes a liquidation feed.

**tab** `string`

Universe to return rows for: `crypto` (default), `equity`, `preipo`, `etf`,
`index`, `commodity` or `fx`. The metric block is identical on every tab.

**limit** `integer`

Rows per page, 1-1000. A paged response is `{ data, pagination }` holding
only the ranked rows; the metric block comes back on unpaged calls.

**cursor** `string`

Opaque cursor from the previous response's `pagination.cursor`.

#### `get_rwa_perp_funding`

Funding and carry for real-world-asset perpetuals (RWA perps: stocks, pre-IPO, ETFs, indices, commodities, FX) across 13 venues. Those venues are CEXs (Binance, Bybit, OKX, Bitget, Gate, Kraken), perp DEXs (Aster, Lighter, Extended, GRVT, ApeX, Pacifica) and Hyperliquid's HIP-3 builder markets. Rates are interval-true and mechanism-true.

**type** `string`

One of `current` (latest per-market snapshot), `history` (session-tagged
settlement time-series for one symbol; Hyperliquid + Kraken), or `stats`
(best carry, top cross-venue spread, weekend premium, open interest).
Defaults to `current`.

**symbol** `string`

Underlying equity ticker (e.g. `TSLA`, `NVDA`, `MSTR`). Required when
`type='history'`. `GOOG` and `GOOGL` are distinct share classes.

**venue** `string`

Filter to a single venue, e.g. `Binance`, `Bybit`, `OKX`, `Kraken`,
`Aster`, `Lighter`, `Pacifica`, or the Hyperliquid HIP-3 builder market (`Hyperliquid`).

**days** `integer`

Lookback days for history mode. Range 1-90. Defaults to `7`.

**limit** `integer`

Rows per page for `type='current'` and `type='history'`, 1-5000.

**cursor** `string`

Opaque cursor from the previous response's `pagination.cursor`.

#### `get_futures_data`

Time-series or snapshot data for 24 MCP/API futures chart types: open interest, liquidations, volume, long/short ratios, funding, basis, term structure, and signal views.

**chart** `string` *required*

Chart type ID. See the `sharpe://charts/futures` resource for all 24 valid
IDs.

**coin** `string`

Base coin ticker. Defaults to `BTC`.

**timeframe** `string`

Lookback window: `1W`, `2W`, `1M`, `3M`, `6M`, `1Y`, or `3Y`. Defaults to
`3M`.

**exchanges** `string`

Comma-separated exchange filter (e.g., `Binance,Bybit,OKX`). Omit for all
defaults.

**limit** `integer`

Rows per page, 1-10000, oldest first. Without `limit`, long series keep
their newest rows and `oi-snapshot` returns each exchange's latest reading.

**cursor** `string`

Opaque cursor from the previous response's `pagination.cursor`.

#### `get_futures_coins`

Lists up to 1,000 coins with futures data, including per-coin capability flags (`hasFunding`, `hasOI`, `hasLiquidations`, `hasLongShort`, `hasCVD`, `hasBasis`), venue coverage, and market-cap rank.

No parameters.

#### `get_derivatives_overview`

Market-wide derivatives snapshot: total OI, average funding rate, OI-weighted funding, top 20 coins by OI (each `top_coins_oi` entry is an asset, its lot spellings included), and exchange/coin counts.

No parameters.

***

### Market data tools

Broad market data covering heatmaps, correlations, price predictions, and token discovery.

#### `get_heatmap`

Market heatmap: coins (a Top N universe, or one narrative's or ecosystem's members) or one tile per narrative or ecosystem, with price change (1h, 4h, 24h, 7d, 30d, 1y), funding APR, RSI(14), relative volume, open interest and OI value change (USD). Tiles are weighted baskets of every eligible member, with member coverage in `constituents` and the median member in `median`. Aggregate narrative and ecosystem responses include explicit complete/partial coverage.

**mode** `string`

Grouping mode: `coins`, `narratives`, or `ecosystems`. Defaults to `coins`.

**category** `string`

Coins-mode universe, one of 39 ids: `top10`, `top20`, `top30`, `top50`
(the default), 15 narratives (e.g. `decentralized-finance-defi`,
`layer-1`, `meme-token`) and 20 ecosystems (e.g. `solana-ecosystem`). The
legacy `top-100` is an alias of `top50`. Ignored in the aggregate modes.

**ex** `string`

Comma-separated CoinGecko coin ids to leave out (e.g. `bitcoin,ethereum`).
Coins mode drops them after the Top N cut without refilling; the
aggregate modes rebuild every tile without them.

#### `get_correlation_matrix`

Pearson correlation matrix for crypto and TradFi assets over a given lookback period.

**period** `string`

Lookback period: `30d`, `90d`, `1y`, or `3y`. Defaults to `30d`.

**ids** `string`

Comma-separated asset IDs. Crypto uses canonical IDs (`bitcoin`,
`ethereum`), TradFi uses short IDs (`sp500`, `gold`, `nvda`). Max 10.

#### `get_market_overview`

BTC and ETH price and 24h return, total crypto market cap and 24h volume, BTC dominance (`btc_market_share`), the total market cap's 24h return, and the Fear and Greed Index. Every return and share is a fraction. Auxiliary source fields are nullable when unavailable.

No parameters. Use this as the first call for any general market question.

#### `get_price_prediction`

Deterministic directional scores with sub-signal breakdowns for bias assessment (bullish/bearish/neutral, 0-100 consensus score, RSI, EMA trends, derivatives signals). Optional 7D/30D values are heuristic scenarios, not calibrated targets or probabilities.

**coin** `string`

Canonical coin slug (e.g., `bitcoin`, `ethereum`, `solana`). Omit for all
coins.

#### `search_market_cap`

Search crypto and supported TradFi assets by name or ticker to find canonical asset IDs and nullable market stats.

**q** `string` *required*

Search query: coin name or ticker. 2-100 characters.

#### `get_gem_finder`

Market-ranked token rows for valuation and momentum screening. Returns market cap, nullable FDV and FDV/MCap ratio, volume, nullable price changes, ATH history, preferred chain scope, observed exchange availability, and enrichment coverage. Ambiguous same-ticker assets do not receive symbol-only exchange attribution. It does not return wallet labels or a proprietary score.

**chain** `string`

Keep only assets whose home chain is this chain (e.g., `solana`, `base`,
`arbitrum`). An asset matches its home chain (`chainSlug`) only, not
chains it is bridged to.
An unknown chain is a 400. Send the same `chain` with each `cursor`.

**limit** `integer`

Number of tokens to return. Range 1-1000. Defaults to `100`.

**cursor** `string`

Snapshot-bound cursor returned by the previous page. Restart without it after the cache refreshes and the cursor expires.

#### `get_stablecoins`

Stablecoin overview, detail, and yield data including nominal supply at peg,
marked value, nullable peg metrics, mechanism mix, chain supply, velocity
coverage, freshness, and APY risk flags.

**type** `string`

Payload type: `overview`, `detail`, or `yields`. Defaults to `overview`.

**slug** `string`

Stablecoin slug for `detail` mode.

#### `get_mindshare`

Narrative mindshare rankings, token-level attention rows, rolling windows, and historical snapshots.

**tokens** `string`

Set to `true` for token rows.

**narrative** `string`

Optional narrative slug.

**historical** `string`

Set to `true` for historical snapshots.

**timeframe** `string`

Historical timeframe: `1W`, `1M`, `3M`, `6M`, `1Y`, or `3Y`.

**window** `string`

Rolling snapshot window: `now`, `24h`, `7d`, or `30d`.

#### `get_web_traffic`

Attention rankings, social snapshots, and market-level signals for coins and narratives, plus CoinGecko trust-score rankings for exchanges.

**type** `string`

Entity type: `exchange`, `coin`, or `narrative`.

**mode** `string`

Payload mode: `rankings`, `snapshots`, or `market`.

**tf** `string`

Lookback window: `7d`, `30d`, `90d`, `1y`, `3y`, or `all`.

**entities** `string`

Comma-separated entity IDs.

**sub** `string`

Market sub-mode when `mode=market`: `trending`, `categories`, or `global`.

***

### Screener tools

Contract and liquidity risk review for tokens.

#### `get_rug_check_security`

Token contract and liquidity risk signals for rug-check review, plus the Rug Check score
the page shows, computed by the API (`score.value` 0-100, `verdict`, `data_completeness`,
`engine_version`) with the `checks` behind it.

**address** `string` *required*

Token contract address.

**chainId** `integer` *required*

Chain or network ID.

#### `get_rug_check_trending`

Trending tokens suitable for rug-check review.

**limit** `integer`

Maximum rows returned. Range 1-100. Defaults to `50`.

#### `get_insider_selling`

Insider selling pressure signals across crypto assets, including wallet concentration, holder-quality risk, sell-side flow, and derivatives confirmation.

**limit** `integer`

Maximum scored coins returned. Range 1-500. Defaults to `100`.

**min\_score** `number`

Minimum 0-10 pressure score to include. Defaults to `0`.

**coin** `string`

One coin's row by its CoinGecko id (e.g., `bitcoin`), exactly as the scorer
wrote it: `score` is `null` once the coin stopped qualifying. `limit` and
`min_score` do not apply to it.

#### `get_pump_dump`

Pump-and-dump manipulation risk signals across crypto assets, including derivatives pressure, holder concentration, liquidity quality, DEX flow, and price behavior.

**limit** `integer`

Maximum scored coins returned. Range 1-500. Defaults to `100`.

**min\_score** `number`

Minimum 0-10 risk score to include. Defaults to `0`.

**phase** `string`

Filter to one manipulation lifecycle phase: `setup`, `markup`,
`distribution`, `dump`, or `dumping`.

**coin** `string`

One coin's row by its CoinGecko id (e.g., `bitcoin`), exactly as the scorer
wrote it: `score` is `null` once the coin stopped qualifying. `limit`,
`min_score` and `phase` do not apply to it.

***

### Arbitrage tools

#### `get_arbitrage_spot_perp`

Spot-perp funding-capture rows with live funding, verified spot or margin
availability, diagnostic basis, gross APR, and net APR after the venue's taker
fees, the adverse entry basis and a known borrow cost, in the board's order
(executable rows first by net APR). Each row carries `perpSymbol`,
`perpOpenInterestUsd`, `fundingIsStale`, `executionStatus` with
`indicativeReason`, `pairStatus`, `breakEvenDays`, `requiresBorrow` /
`borrowCostIncluded`, `apr7d` / `carrySignFlip7d`, `fundingAsOf` and per-leg
price times. The whole board is about 2.4 MB, so the tool asks for a 100-row
page unless given `limit` or `cursor`.

**exchange** `string`

Exchange name (e.g., `Binance`, `Bybit`) or `all`. Defaults to `all`.

**direction** `string`

Perpetual-leg direction: `all`, `short` for positive funding capture, or
`long` for negative funding capture. Defaults to `all`.

**minOiUsd** `number`

Minimum open interest in USD on the perp leg (`perpOpenInterestUsd`). A row
whose open interest is unknown fails a floor above 0. Default 0 (no floor).

**limit** `integer`

Rows per page (1 to 1000), in board order. The tool sends `100` unless
`limit` or `cursor` is given.

**cursor** `string`

Cursor for the next page (`pagination.cursor`).

#### `get_arbitrage_cross_exchange`

Cross-exchange funding arbitrage across every funding venue, one row per asset
(its best executable pair, else its largest gross differential), ranked with
executable rows first by net APR, then indicative rows by net APR or gross
annualized funding differential. Executable means a book-priced spread, legs
within 5%, reported top-of-book depth of at least \$10,000 and fresh quotes;
otherwise `indicativeReason` says why. Net APR charges both venues' taker fees
and the adverse entry spread, never crediting a favourable one; unknown market
data is null, never zero. Each row carries `pairStatus`, `breakEvenDays`,
`roundTripFeeRate`, the legs' symbols and intervals, `fundingAsOf` and per-leg
price times.

**exchanges** `string`

Comma-separated venues to compare (e.g., `Binance,Bybit,Hyperliquid`).
Omit for every funding venue (a venue the instrument master marks not live
is skipped).

**minOiUsd** `number`

Minimum open interest in USD on the smaller leg. Legs with unknown OI
fail the floor. Default 0 (no floor).

**minVolUsd** `number`

Minimum 24h volume in USD on the smaller leg. Legs with unknown volume
fail the floor. Default 0 (no floor).

**assetClass** `string`

Underlying filter: `all` (default), `crypto`, or `rwa` (equity,
commodity, FX and index perps). Pairs never cross asset classes.

**sector** `string`

Narrative filter: `all` (default), `memes`, `ai-agents`, `layer-1` or
`defi`. Keeps only crypto coins in that narrative's CoinGecko category;
RWA perps are left out when a sector is set.

**limit** `integer`

At most this many rows, the first ones in the board's order (executable
first). Default: every row.

**cursor** `string`

Cursor for the next page (`pagination.cursor`; 100 rows a page when `limit`
is omitted).

#### `get_arbitrage_dated_futures_basis`

Spot-futures cash-and-carry scanner rows for buying spot and selling dated
futures, ranked by net APR after 2 spot and 2 futures taker fills: rows at least
3 days from expiry first, executable rows first within them, then
`snapshot_quote` rows (executable on a live read). `indicativeReason` names why
a row is not executable.

**coin** `string`

Optional base coin ticker, e.g. `BTC`, `ETH`, or `SOL`.

**exchanges** `string`

Comma-separated exchange filter, e.g. `Binance,Bybit,OKX`.

**minNet** `number`

Minimum of the board's net figure, as a fraction (`0.05` is 5%): `netApr`
(basis), `netRollApy` (calendar), `netCarryApr` (carry: the annualized net
carry, not the edge to expiry).

**minOiUsd** `number`

Minimum open interest in USD.

**minVolumeUsd** `number`

Minimum 24-hour volume in USD.

**minDepthUsd** `number`

Minimum executable depth in USD when available.

**marginType** `string`

Futures margin type: `linear`, `inverse`, or `both`.

**notional** `number`

Position notional in USD. Defaults to `10000`.

**limit** `integer`

Maximum rows returned. Range 1 to 1000. Defaults to `100`.

**cursor** `string`

Cursor for the next page.

#### `get_arbitrage_futures_calendar_spread`

Near-versus-far dated futures curve scanner rows with forward yield and net
roll APY after 4 futures and 2 spot taker fills; direction and curve come from
mark (else mid) prices. Pairs with a near leg under 3 days or a gap under 7 days
(`belowTenorFloor`) rank last.

**coin** `string`

Optional base coin ticker, e.g. `BTC`, `ETH`, or `SOL`.

**exchanges** `string`

Comma-separated exchange filter, e.g. `Binance,Bybit,OKX`.

**minNet** `number`

Minimum of the board's net figure, as a fraction (`0.05` is 5%): `netApr`
(basis), `netRollApy` (calendar), `netCarryApr` (carry: the annualized net
carry, not the edge to expiry).

**minOiUsd** `number`

Minimum open interest in USD.

**minVolumeUsd** `number`

Minimum 24-hour volume in USD.

**minDepthUsd** `number`

Minimum executable depth in USD when available.

**marginType** `string`

Futures margin type: `linear`, `inverse`, or `both`.

**notional** `number`

Position notional in USD. Defaults to `10000`.

**limit** `integer`

Maximum rows returned. Range 1 to 1000. Defaults to `100`.

**cursor** `string`

Cursor for the next page.

#### `get_arbitrage_perp_dated_carry`

Perp funding versus dated futures carry rows: the dated contract's basis
against the perp (not spot) at the trade's executable sides, against the funding
expected to expiry from the 7-day realised average (`fundingProjection`).
Rows carry `direction` and `crossVenue` (the legs usually sit on two venues with
separate collateral) and the 7-day cumulative funding as `funding7dCumulative`, a fraction.

**coin** `string`

Optional base coin ticker, e.g. `BTC`, `ETH`, or `SOL`.

**exchanges** `string`

Comma-separated exchange filter, e.g. `Binance,Bybit,OKX`.

**minNet** `number`

Minimum of the board's net figure, as a fraction (`0.05` is 5%): `netApr`
(basis), `netRollApy` (calendar), `netCarryApr` (carry: the annualized net
carry, not the edge to expiry).

**minOiUsd** `number`

Minimum open interest in USD.

**minVolumeUsd** `number`

Minimum 24-hour volume in USD.

**minDepthUsd** `number`

Minimum executable depth in USD when available.

**marginType** `string`

Futures margin type: `linear`, `inverse`, or `both`.

**notional** `number`

Position notional in USD. Defaults to `10000`.

**limit** `integer`

Maximum rows returned. Range 1 to 1000. Defaults to `100`.

**cursor** `string`

Cursor for the next page.

#### `get_arbitrage_cex_spot_transfer`

CEX spot-transfer routes after exact network matching, token-contract identity,
withdrawal/deposit status and minimums, withdrawal fee, per-venue taker fees,
depth and slippage. Routes netting above zero come first; up to 50 near misses
follow as indicative `below_fees`. Books are judged on 60 seconds, networks on
10 minutes; `meta.transferScan` counts what the scan evaluated.

**coin** `string`

Optional base coin ticker, e.g. `BTC`, `ETH`, or `SOL`.

**exchanges** `string`

Comma-separated exchange filter, e.g. `Binance,Bybit,OKX`.

**minNet** `number`

Minimum `netReturn` (per trip, not annualized), as a fraction (`0.001` is
0.1%).

**minDepthUsd** `number`

Minimum executable depth in USD when available.

**notional** `number`

Position notional in USD. Defaults to `10000`.

**limit** `integer`

Maximum rows returned. Range 1 to 1000. Defaults to `100`.

**cursor** `string`

Cursor for the next page.

#### `get_arbitrage_borrow_rates`

Spot-margin borrow rates per coin across Binance, OKX, Bybit and Gate.io, the
venues that publish them without an account. One row per coin with every
venue's quote cheapest first: `hourlyRate` (fraction per hour) and `annualRate`
(`hourlyRate × 8,760`, simple). A venue that does not price a coin is absent,
never 0; `venues` reports each venue's status (`ok`, `stale`, `failed`,
`unsupported`).

**coin** `string`

Optional borrowed asset, e.g. `BTC`, `USDT`, or `PEPE`.

**exchanges** `string`

Comma-separated venues: `Binance`, `OKX`, `Bybit`, `Gate.io`. Default: all.

#### `get_arbitrage_funding_spread_history`

A pair's historical funding spread and carry backtest from stored settlements:
a spot-perp carry on one venue, or a long and a short perp across venues. Legs
are aligned by settlement time with each contract's real interval (never an
assumed 8h); `series` carries `spreadApr`, `legAprs`, `cashflow` and
`cumulativeCarry`, and `backtests` the 1, 7, 14, 30 and 60-day windows below
`days` plus `days` itself: `fundingCollected`, `fees` (entry and exit taker
fills at each venue's standard rate), `netReturn`, `grossApr`, `netApr`,
`negativeCarryDays`, `maxDrawdown`, `breakEvenDays`, `coverageRatio`. All
fractions.

**mode** `string`

`spot-perp` (default) or `cross-exchange`.

**coin** `string`

Base coin, e.g. `BTC`. Required.

**venue** `string`

Spot-perp venue: Binance, OKX, Bybit, Bitget, Gate.io, KuCoin, MEXC, BingX or
HTX.

**contract** `string`

Spot-perp perp contract symbol, e.g. `BTCUSDT`. Optional: the venue's
contract with the largest open interest otherwise.

**direction** `string`

Spot-perp: `short` (default, buy spot / short perp) or `long` (sell spot /
long perp; borrow interest not included).

**longVenue** `string`

Cross-exchange long perp venue.

**longContract** `string`

Cross-exchange long perp contract symbol. Optional.

**shortVenue** `string`

Cross-exchange short perp venue.

**shortContract** `string`

Cross-exchange short perp contract symbol. Optional.

**days** `integer`

Backtest window, 1 to 90 days. Defaults to `30`.

#### `get_arbitrage_fixed_floating_funding`

Pendle Boros fixed vs floating funding: every live Boros market (a venue's perp
to a maturity: Binance, OKX, Bybit, Gate, KuCoin, Hyperliquid incl. the xyz
dex, Lighter) with `impliedApr` (Boros's fixed rate), `floatingApr` (the
venue's current funding as Boros reports it), `realised7dApr` and
`realised30dApr` (Sharpe's stored funding for the same contract,
`acc × 365 / days`) and `spread7dApr` / `spread30dApr` = implied − realised:
positive means locking the fixed rate beats the floating leg. Fractions per
year, gross of fees. A missing realised figure is `null` with
`realised7dNullReason` / `realised30dNullReason`, never 0. Each row also
carries the executable edge at the Boros quote, `edge7dApr` and `edge30dApr`
(the better of receiving fixed at the bid or paying it at the ask against
realised funding; `edge30dSide` names the side), Boros's `takerFeeApr` and
`settleFeeApr`, and `netEdge30dApr` = `edge30dApr` − both fees. Rows rank by
`netEdge30dApr`, highest first: markets under 3 days to maturity rank last,
and a market without a net edge (no quote, realised figure or fee) ranks after
those with one. Ties fall to the 7-day net edge, then `impliedApr`, then `marketId`.

**coin** `string`

Optional underlying, e.g. `BTC`, `ETH`, `HYPE`, `BRENTOIL`.

**venue** `string`

Optional venue: Boros's name (`Binance`, `OKX`, `Hyperliquid`, `Gate`,
`Kucoin`, `Lighter`, `Bybit`) or Sharpe's (`Gate.io`, `KuCoin`,
`tradeXYZ`).

***

### Category tools

Sector, chain, and memecoin narrative analytics.

#### `get_narratives`

Analytics for 30 MCP narrative slugs: L1, L2, DeFi, AI Agents, DePIN, RWA, Gaming, and more. Returns market cap, volume, performance, and social sentiment per narrative.

**narrative** `string`

Narrative slug for detail view (e.g., `defi`, `ai-agents`, `rwa`,
`layer-1`). See `sharpe://narratives` resource for all 30 MCP slugs. Omit
for overview of all.

**correlation** `string`

Set to `true` to include a correlation matrix for the narrative's tokens.

**timeframe** `string`

Timeframe for correlation data (e.g., `30d`, `90d`).

**sort** `string`

Order the list by 24h return: `-return24h` (highest first) or `return24h`.
A narrative without a 24h return comes last either way.

**top** `integer`

Adds `top`: the N narratives with the highest 24h change (1-50). A narrative
without a 24h change is never ranked.

**bottom** `integer`

Adds `bottom`: the N narratives with the lowest 24h change, lowest first (1-50).

#### `get_ecosystems`

Analytics for 25 blockchain ecosystems: Ethereum, Solana, BNB Chain, Arbitrum, Base, and more. Returns market cap, volume, TVL, and performance per ecosystem.

**ecosystem** `string`

Ecosystem slug (e.g., `ethereum`, `solana`, `arbitrum`, `base`). See
`sharpe://ecosystems` resource for all 25 slugs. Omit for overview.

**excludeNative** `string`

Set to `true` to exclude the chain's native token from aggregate metrics.

**correlation** `string`

Set to `true` for a token correlation matrix within the ecosystem.

**timeframe** `string`

Timeframe for correlation data (e.g., `30d`, `90d`).

#### `get_memecoins`

Memecoin narrative data across grouped categories: Dog, Cat, Frog, AI, Solana, Base, Pump.fun, and more. Returns market cap, market share, volume, freshness, calculation method, short-term momentum score, and top coins per category.

**narrative** `string`

Memecoin narrative slug (e.g., `dog-coins`, `cat-coins`, `frog-coins`,
`ai-memes`, `trump-coins`). Omit for all.

**historical** `string`

Include time-series snapshots: `24h`, `7d`, `30d`, or `1y` for trend
analysis.

**coinHistory** `string`

In narrative detail mode, include top-coin price history: `24h`, `7d`, `1m`,
or `1y`.

#### `get_memecoin_launches`

Recently launched memecoin pairs screened by age, liquidity, volume, and transaction count. This is a discovery feed, not a contract-security verdict.

**chains** `string`

Comma-separated chain ids. Default `solana,bsc`, the chains with a recognised meme launchpad; other chains return no rows yet.

**days** `number`

Launch age window in days, from 1 to 30.

**limit** `number`

Maximum launch rows, from 1 to 200.

**profile** `string`

Screening profile: `discovery`, `balanced`, or `strict`.

#### `get_news`

Aggregated crypto news feed from multiple sources, ranked by reliability tier.

**limit** `integer`

Number of articles. Range 1-500. Defaults to `200`.

**offset** `integer`

Number of articles to skip before returning results, for pagination.
Defaults to `0`.

**category** `string`

Filter by category: `all`, `crypto`, `tradfi`, `macro`, `geopolitics`,
`research`, or `ai`.

**coin** `string`

Filter by canonical coin slug (e.g., `bitcoin`, `ethereum`).

**since** `string`

ISO 8601 timestamp. Only articles published after this time are returned.

**q** `string`

Search article titles across the stored news corpus. Range 1-200
characters.

***

### New listings tools

Listing lifecycle events across CEXs and Perp DEXs, tagged by narrative and source confidence. Use these as a forward signal for where exchange liquidity is being deployed.

#### `get_exchange_listings`

Aggregated hub payload: weekly + monthly listing counts by narrative and exchange, last 90 days of recent listings, and summary stats (WoW/MoM deltas, top narratives of the month, top exchanges of the month). Best tool for "which narratives are CEXs deploying listing slots toward?".

**narrative** `string`

Filter to a single narrative slug (e.g., `ai-agents`, `memes`, `layer-1`,
`rwa`, `defi`). All returned counts are scoped to that narrative. Omit for
all narratives.

**exchange** `string`

Filter to a single exchange. Legacy aggregate rows are currently populated
for enabled compatibility venues.

#### `get_recent_listings`

Flat feed of recent listings, one row per token-exchange pair. Event-filtered responses include `last_updated_at`, `partial`, and `provider_coverage`; agents should inspect these before treating a quiet feed as a market signal.

**narrative** `string`

Filter to a single narrative slug.

**exchange** `string`

Filter to a single exchange. Event filters can include registry venues such
as `bitget`, `hyperliquid`, or `aster`.

**venue\_type** `string`

Optional event-feed venue filter: `cex`, `perp_dex`, or `dex`.

**market\_type** `string`

Optional event-feed market filter: `spot`, `perp`, `futures`, `options`, or
`margin`.

**event\_type** `string`

Optional event type filter: `listing`, `delisting`, `suspension`,
`resumption`, or `prelaunch`.

**asset\_class** `string`

Optional listed instrument class: `token`, `spot_pair`, `perp_contract`,
`futures_contract`, or `options_contract`.

**status** `string`

Optional event status: `announced`, `scheduled`, `live`, `completed`,
`cancelled`, or `needs_review`.

**confidence** `string`

Optional source confidence: `authoritative`, `high`, `medium`, `low`,
`proxy`, or `manual`.

**from** `string`

ISO date or datetime lower bound.

**to** `string`

ISO date or datetime upper bound.

**days** `integer`

Lookback window in days. Range 1-365. Defaults to `90`.

**limit** `integer`

Max rows returned. Range 1-1000. Defaults to `200`.

**cursor** `string`

Opaque cursor returned by event feed pages. Pass it through unchanged.

#### `get_listing_events`

Canonical listing event feed across spot, perp, futures, and options markets. Returns event type, instrument id, status, source URL, source confidence, real source-observation freshness, and per-provider health. `generated_at` is response assembly time; use `last_updated_at` for freshness.

**exchange** `string`

Optional exchange or perp DEX id.

**venue\_type** `string`

`cex`, `perp_dex`, or `dex`.

**market\_type** `string`

`spot`, `perp`, `futures`, `options`, or `margin`.

**event\_type** `string`

`listing`, `delisting`, `suspension`, `resumption`, or `prelaunch`.

**asset\_class** `string`

`token`, `spot_pair`, `perp_contract`, `futures_contract`, or
`options_contract`.

**status** `string`

`announced`, `scheduled`, `live`, `completed`, `cancelled`, or
`needs_review`.

**narrative** `string`

Sharpe narrative slug.

**confidence** `string`

`authoritative`, `high`, `medium`, `low`, `proxy`, or `manual`.

**from** `string`

ISO date or datetime lower bound.

**to** `string`

ISO date or datetime upper bound.

**days** `integer`

Lookback window in days. Range 1-365. Defaults to `90`.

**limit** `integer`

Max rows returned. Range 1-1000. Defaults to `200`.

**cursor** `string`

Opaque two-stream cursor for the next page. Pass it through unchanged.

#### `get_listing_exchanges`

Typed connector registry for supported listing venues, including market coverage, source docs, enabled status, polling group, and parser confidence.

**venue\_type** `string`

Optional venue type filter.

**market\_type** `string`

Optional supported-market filter.

**enabled** `string`

`true` or `false`.

***

### System tools

#### `get_api_coverage`

Metadata about all available data products: supported exchanges, coins, chart types, timeframes, and update frequencies. Call this first to discover what data is available before making specific queries.

No parameters.

***

## Resources

The server exposes 5 MCP resources that provide reference data for valid parameter values and for the fields the tools return.

**sharpe://charts/futures** `JSON array`

All 24 valid futures chart IDs with descriptions. Use these IDs with
`get_futures_data`.

**sharpe://exchanges** `JSON object`

Supported exchanges per product: 35 for funding rates, and 5 default + 5
extra for futures.

**sharpe://narratives** `JSON array`

All 30 MCP narrative slugs and names for use with `get_narratives`.

**sharpe://ecosystems** `JSON array`

All 25 ecosystem slugs, names, and native tokens for use with
`get_ecosystems`.

**sharpe://fields** `JSON array`

The field dictionary: the served fields that have an entry (funding and
open interest today), by the id the API document gives each (`x-field`),
with its label, unit or type, meaning, grain, source and what `null`
means.

***

## Prompts

The server includes 2 guided prompt templates that walk AI agents through multi-step analysis workflows.

### `market_analysis`

Guides the agent through a 6-step market analysis: market overview, derivatives health, sector rotation, ecosystem flows, arbitrage opportunities, and synthesis into a bullish/bearish/neutral verdict.

No parameters.

### `coin_deep_dive`

Guides the agent through an in-depth single-coin analysis: quick analysis, futures deep dive (OI, long/short, liquidations, basis), funding history, correlations, price prediction, and a final synthesis with key levels and risk factors.

**coin** `string`

Coin ticker. Defaults to `BTC`.

***

## Environment variables

**SHARPE\_API\_KEY** `string`

Required. API key, on a paid plan or in its one-time trial; every tool calls `/api/v1/` with it
and draws on the key's quota. Without it the server starts and lists its
tools, and every tool call answers how to get a key.

**SHARPE\_API\_URL** `string`

Site root for API calls. Defaults to `https://www.sharpe.ai`;
legacy `/api` or `/api/v1` base values are normalized.

Custom base URLs must use `https://`, except local development hosts such as `http://localhost`, `http://127.0.0.1`, and `http://[::1]`. The server refuses HTTP redirects from API calls so credentials are not forwarded to unexpected hosts.

***

## Paging and the context window

A `type=current` read of `get_funding_rates` leaves out the rows not written
for 6 hours, as `/v1/funding/rates` does.

When a page is larger than the context-window cap, the tool keeps the rows that
fit and points `pagination.cursor` at the first row it left out, so following
the cursor skips nothing. `get_funding_rates`, `get_gem_finder`, `get_arbitrage_spot_perp`, `get_news`
and `get_funding_settlement` ask for a 25-row page when the call names none.
`get_api_coverage` takes no page and is never cut: it answers whole.

### Get an API key

Choose a plan at [/pricing](https://www.sharpe.ai/pricing) and pay at [/dashboard/billing](https://www.sharpe.ai/dashboard/billing), then create your key from the [API key dashboard](https://www.sharpe.ai/dashboard/api-keys) and set it as `SHARPE_API_KEY` in your MCP client configuration (or send it as the `Authorization` header to the hosted endpoint). The full key is shown once at creation time. Each account has one key, shared by the REST API and the MCP server.

***

## Example prompts

These natural language prompts show how AI agents route to the correct tools.

| Prompt | Tools triggered |
| - | - |
| "What are the current funding rates for BTC across exchanges?" | `get_funding_rates` with `type='current'` |
| "Give me a full market briefing" | `market_briefing` (composite: market overview + narratives + funding) |
| "Show me the open interest chart for ETH over the last month" | `get_futures_data` with `chart='oi-stacked'`, `coin='ETH'`, `timeframe='1M'` |
| "What arbitrage opportunities exist right now?" | `find_opportunities` (composite: spot-perp + cross-exchange + funding summary) |
| "How are AI and DeFi narratives performing this week?" | `get_narratives` with `narrative='ai-agents'`, then `get_narratives` with `narrative='defi'` |
| "Deep dive on SOL: derivatives, funding, everything" | `coin_deep_dive` prompt, or `analyze_coin` with `coin='SOL'` |
| "Find me some hidden gem tokens" | `get_gem_finder` |
| "Which narratives are getting the most CEX listings this month?" | `get_exchange_listings` (returns top narratives by month + WoW/MoM deltas) |
| "What new AI-agent tokens listed on MEXC in the last 30 days?" | `get_recent_listings` with `narrative='ai-agents'`, `exchange='mexc'`, `days=30` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.