io.github.OrderlyNetwork/orderly-mcp

Get a curated, step-by-step guide for a common Orderly development task such as wallet connection, deposits, SDK setup, or placing orders. Returns exactly one best-matching workflow as Markdown with prerequisites, numbered steps, TypeScript examples, common issues, and related workflows; pass the task in natural language or a partial name, and a miss lists available workflows. Read-only lookup from bundled data — no network calls, credentials, rate limits, or side effects. Use for end-to-end tasks, not one-off lookups: get_component_guide for a known UI component, search_orderly_docs (scope 'sdk') for symbols, get_api_info for core endpoints, and the matching named tool for Indexer, Public Info, Orderly One, or Strategy Vault data.

Get reference documentation for the core Orderly trading API: REST endpoints, WebSocket streams, or authentication. For `rest` or `websocket`, omitting `endpoint` lists every endpoint or stream with base URLs and auth requirements; supplying `endpoint` fuzzy-matches one item and returns its method/path or topic, auth, rate limits, parameters, message formats, and a TypeScript example. `type: 'auth'` returns the signing flow and ignores `endpoint`. Read-only bundled docs — it does not call the API and requires no credentials, rate limits, or side effects. Use `type` alone to discover valid names, then `endpoint` for detail; for historical analytics use get_indexer_api_info, for zero-auth public data use get_public_info_api_info, for DEX management use get_orderly_one_api_info, and for vault data use get_strategy_vault_api_info.

Get a curated build guide for a React UI component from the Orderly SDK, such as order-entry, orderbook, positions, or wallet-connector. Returns Markdown with required packages, key hooks, a complete TSX example, tips, styling notes, common mistakes, and related components; `complexity` selects the example depth — 'minimal' for a scaffold, 'advanced' for production wiring — and falls back to 'standard'. Guides include full code and can be long; a miss lists available guides and points to search_orderly_docs. Read-only static guidance — no network calls, credentials, rate limits, or side effects. Use for a known UI component; for SDK hook/type signatures use search_orderly_docs (scope 'sdk'), for end-to-end steps use explain_workflow, and for backend endpoints use get_api_info or the matching domain API tool.

Get the deployed smart contract addresses for Orderly on a specific chain and network. `chain` is required; `contractType` filters to one contract (e.g. vault, usdc, usdt) or 'all'; `network` selects mainnet (default) or testnet. 'all' lists every contract with an address on the selected network; a specific type also returns its description and the address on the other network when available. Unknown chains or contract types return the valid options. Read-only lookup from bundled data — no network calls, credentials, or side effects. Use for deployment and wiring addresses only; for API details use get_api_info or the matching named API tool, for SDK symbols use search_orderly_docs, and for integration steps use explain_workflow.

Get reference documentation for the Orderly Indexer API, a read-only source of historical and aggregated trading data: volume and fee metrics, account events, trades, and rankings. Omit both parameters for an overview with base URLs, categories, common errors, and usage tips; pass `category` to discover all endpoints in an area, or `endpoint` to fuzzy-match one endpoint and return its parameters, request/response schemas, and TypeScript example (category takes precedence if both are supplied). Bundled docs lookup only — no API call, credentials, or rate limits. Use for analytics, dashboards, account history, and leaderboards; for live trading operations use get_api_info, and for zero-auth market data use get_public_info_api_info.

Get reference documentation for the Orderly One API used to create, graduate, and manage a DEX, covering auth, DEX, graduation, theme, stats, leaderboard, and admin endpoints. Omit both parameters for an overview; pass `category` to discover all endpoints in an area, or `endpoint` to fuzzy-match one endpoint and return its method, parameters, and examples (category takes precedence if both are supplied). Responses flag agent-blocked or conditional operations such as DEX creation, deployment, and deletion. Read-only bundled docs — it never calls the API or requires credentials. Use for Orderly One/DEX-builder tasks; for core trading use get_api_info, for vault data use get_strategy_vault_api_info, and for analytics use get_indexer_api_info or get_public_info_api_info.

Get reference documentation for the Orderly Public Info API — a zero-auth single endpoint (POST /v1/public/query) for market, account, and platform data selected by a `type` field. Covers 24 query types (marketSummary, accountState, orderbook, candles, topAddresses, whaleContext, etc.); `queryType` accepts exact, partial, or fuzzy names and returns params, response fields, example, weight, and freshness; `category` lists a group (queryType wins if both are supplied); omit both for the overview and rate-limit rules. Read-only bundled docs — it does not call the endpoint. Use instead of get_api_info for zero-auth public data; use get_api_info for authenticated trading, get_indexer_api_info for historical analytics, and get_strategy_vault_api_info for vault data.

Get reference documentation for the Orderly Strategy Vault REST API covering vault performance, strategy providers, fund management, liquidity providers, and user stats. Omit both parameters for an overview with base URL and categories; pass `category` to discover all endpoints in an area, or `endpoint` to fuzzy-match one endpoint and return its full detail (category wins if both are supplied). Read-only bundled docs — it does not call the API and requires no credentials or rate limits. Use for vault/yield integrations; for core trading use get_api_info, for historical analytics use get_indexer_api_info, and for zero-auth market data use get_public_info_api_info.

Search bundled Orderly docs and SDK symbols by topic or question. Returns up to `limit` ranked Markdown results with relevance scores: `scope: 'sdk'` returns hooks/components/types/functions with signatures, props, and source paths; `'docs'` returns prose; `'auto'` (default) picks the corpus from the query. Use `'sdk'` for exact symbol signatures and `detail: 'full'` only when the summary is insufficient, since it returns much longer text. Read-only local search — no network calls, credentials, rate limits, or side effects. Use for open-ended discovery when the component, workflow, or endpoint is unknown; for a known component use get_component_guide, for a task walkthrough use explain_workflow, for an endpoint use get_api_info, get_indexer_api_info, get_public_info_api_info, or get_strategy_vault_api_info, and for addresses use get_contract_addresses.