> For the complete documentation index, see [llms.txt](https://ottodata.gitbook.io/ottodata-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ottodata.gitbook.io/ottodata-docs/mcp-for-ai-agents/tool-reference.md).

# Tool reference

## Tool reference

All 17 tools are read-only queries. Parameters mirror the [REST API](https://ottodata.gitbook.io/ottodata-docs/api-reference/overview) — each tool wraps one endpoint.

### Basis & gaps

| Tool                  | Parameters                | Returns                                                                                                         |
| --------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `hood_basis_snapshot` | —                         | Latest basis tick for all 32 tickers: `chainlink_px`, `ref_last`, `basis_bps`, `overnight_bps`, `oracle_paused` |
| `hood_basis_history`  | `ticker`, `limit` (≤5000) | Minute-level basis history, newest first                                                                        |
| `hood_gaps_summary`   | `days` (≤90)              | Overnight + weekend gap statistics per ticker                                                                   |
| `hood_gaps_live`      | —                         | Current off-hours session ranked by gap (or `regular` if market open)                                           |
| `hood_gap_sessions`   | `ticker`, `days` (≤90)    | Session-by-session gap history for one ticker                                                                   |

### Pools & risk

| Tool               | Parameters    | Returns                                                                              |
| ------------------ | ------------- | ------------------------------------------------------------------------------------ |
| `hood_pools`       | —             | Tracked Uniswap pools: pool price, liquidity USD, deviation vs Chainlink             |
| `oracle_deviation` | `min_abs_bps` | Chainlink-vs-pool deviations sorted by magnitude, with `ok`/`warning`/`alert` status |
| `stable_risk`      | —             | Stablecoin prices vs $1 peg with depeg status                                        |

### Flows

| Tool           | Parameters                                                                     | Returns                                                        |
| -------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------- |
| `token_flows`  | `ticker`, `min_usd`, `direction` (mint/burn/transfer), `hours` (≤168), `limit` | Large transfers of stock tokens + USDG                         |
| `flow_summary` | `hours` (≤168)                                                                 | Per-ticker aggregates: volume, mint/burn USD, largest transfer |

### Social

| Tool                   | Parameters                                     | Returns                                                                    |
| ---------------------- | ---------------------------------------------- | -------------------------------------------------------------------------- |
| `reddit_alpha_signals` | `tickers`, `signal_type`, `min_alpha`, `limit` | Reddit ticker-alpha signals                                                |
| `reddit_market_regime` | —                                              | Current Reddit-derived market regime + confidence                          |
| `hood_attention`       | `min_alpha`                                    | Reddit attention × live basis join for Hood tickers (fan-out deduplicated) |

### News & chain

| Tool                | Parameters                                         | Returns                                                   |
| ------------------- | -------------------------------------------------- | --------------------------------------------------------- |
| `market_events`     | `symbols`, `event_type`, `min_importance`, `limit` | Classified market news events                             |
| `chain_deployments` | `limit`, `verified_only`, `tokens_only`            | Contract deployments on Hood (full history since genesis) |
| `chain_stats`       | `days` (≤365)                                      | Deploy analytics: daily counts, top deployers, totals     |

### Registry

| Tool         | Parameters | Returns                                                           |
| ------------ | ---------- | ----------------------------------------------------------------- |
| `hood_feeds` | —          | The full feed + token contract registry (32 equities + 20 crypto) |

### Suggested agent recipes

* **Dislocation scan**: `hood_gaps_live` → for the top ticker, `hood_pools` + `token_flows` to see if the DEX and whales confirm the move.
* **Attention cross-check**: `hood_attention` → for any ticker with high alpha *and* large `overnight_bps`, pull `hood_basis_history` for context.
* **Risk sweep**: `oracle_deviation(min_abs_bps=100)` + `stable_risk` for a one-shot health check of the chain's pricing layer.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ottodata.gitbook.io/ottodata-docs/mcp-for-ai-agents/tool-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.