Documentation Index
Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt
Use this file to discover all available pages before exploring further.
MCP-сервер OrbitFlare открывает доступ к оптимизированному под Shredstream RPC Solana, gRPC-стримингу, выделенным нодам и инфраструктуре валидаторов как к инструментам, которые ваш AI-ассистент может вызывать напрямую. Каждая возможность — отдельный инструмент со схемой ввода: без внутренних маршрутизаторов и пагинации по result-id.
Сочетайте MCP-сервер с Skill: skill объясняет как устроен OrbitFlare; MCP позволяет вызывать API из чата.
Установка
У большинства хостов один JSON; отличается только путь к файлу:
{
"mcpServers": {
"orbitflare": {
"command": "npx",
"args": ["@orbitflare/mcp@latest"],
"env": {
"ORBITFLARE_API_KEY": "your-license-key",
"ORBITFLARE_NETWORK": "mainnet"
}
}
}
}
| Host | Where to put it |
|---|
| Claude Desktop | ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) · %APPDATA%\Claude\claude_desktop_config.json (Windows) |
| Claude Code | run claude mcp add orbitflare -- npx @orbitflare/mcp@latest, or drop a .mcp.json at your project root |
| Cursor | ~/.cursor/mcp.json (global) or <project>/.cursor/mcp.json |
| Gemini CLI | ~/.gemini/settings.json (global) or <project>/.gemini/settings.json |
| Windsurf | ~/.codeium/windsurf/mcp_config.json |
| VS Code | depends on extension (Continue, Cline, GitHub Copilot agent mode) |
Codex CLI использует TOML: ~/.codex/config.toml (или <project>/.codex/config.toml):
[mcp_servers.orbitflare]
command = "npx"
args = ["@orbitflare/mcp@latest"]
Лицензионный ключ
Зарегистрируйтесь на orbitflare.com и скопируйте ключ в разделе Licenses дашборда. На Free — 10 RPS, этого достаточно, чтобы начать.
Если не хотите класть ключ в конфиг хоста, не задавайте переменную и вызовите из чата setApiKey:
Set my OrbitFlare API key to xxxx-xxxx-xxxx.
Конфигурация
| Env var | Purpose |
|---|
ORBITFLARE_API_KEY | RPC license key (used as ?api_key= for JSON-RPC) |
ORBITFLARE_LICENSE_KEY | Alias for ORBITFLARE_API_KEY |
ORBITFLARE_CUSTOMER_API_KEY | Customer API v2 key (X-ORBIT-KEY header). Falls back to ORBITFLARE_API_KEY if unset |
ORBITFLARE_NETWORK | mainnet (default) or devnet |
ORBITFLARE_RPC_URL | Optional explicit RPC endpoint URL (overrides region/network). Useful for dedicated nodes. |
ORBITFLARE_BEARER_TOKEN | Bearer token for the Customer API. Auto-populated by pollDeviceToken / verifyWalletSignature and persisted at ~/.orbitflare/mcp-session.json. |
Все значения можно переопределить во время работы через инструмент setApiKey — удобно при смене сети или региона без перезапуска хоста.
Региональные эндпоинты
По умолчанию mainnet (авто-маршрутизация). Чтобы зафиксировать регион, вызовите setApiKey с одним из: ash, ny, la, slc, ams, fra, lon, dub, siau, tok, sgp.
Инструменты
53 инструмента по доменам. Каждый вызывается независимо.
Чтение RPC
| Tool | What it does |
|---|
getBalance | SOL balance for a pubkey, in lamports and SOL |
getAccountInfo | Full account info with jsonParsed decoding when available |
getMultipleAccounts | Batch up to 100 accounts in one call |
getProgramAccounts | Accounts owned by a program (filters + dataSlice required for popular programs) |
getTokenAccountsByOwner | All SPL token accounts a wallet owns |
getTokenAccountBalance | Balance of a specific SPL token account |
getTokenSupply | Total supply for an SPL mint |
getTransaction | Parsed transaction by signature |
getSignaturesForAddress | Recent signatures (paginated via before / until) |
getBlock | Block metadata + transactions at a slot |
getSlot | Current slot |
getEpochInfo | Epoch number, slot index, slots-in-epoch, progress |
getNetworkStatus | Health + version + identity + slot in one call |
getLatestBlockhash | Recent blockhash + lastValidBlockHeight |
getFeeForMessage | Lamport fee for a compiled message |
getMinimumBalanceForRentExemption | Min lamports for rent exemption |
getStakeActivation | Active/inactive lamports + state for a stake account |
getRecentPrioritizationFees | Priority-fee samples + P50/P75/P90/P99 percentiles |
simulateTransaction | Simulate a tx; returns logs + units consumed |
sendTransaction | Submit an already-signed base-64 transaction |
Аккаунт, профиль и планы
| Tool | What it does |
|---|
setApiKey | Store an RPC or Customer API key for the session, optionally switch network/region |
getProfile | Authenticated user profile + account balance |
updateProfile | Update name, email, payment wallet |
listLicenses | All RPC licenses on the account |
listRpcPlans | Catalog of available plans with pricing |
Аутентификация (device code + challenge кошелька)
| Tool | What it does |
|---|
requestDeviceCode | Start device-authorization flow; returns verification_uri + user_code |
pollDeviceToken | Poll for completion; auto-stores Bearer token on success |
revokeToken | Logout / clear Bearer token |
requestWalletChallenge | Get a one-time challenge string for a Solana wallet |
verifyWalletSignature | Sign in an existing account by signature |
registerWithWallet | Create a new account from a wallet signature |
API-ключи и лицензии
| Tool | What it does |
|---|
listApiKeys | List all API keys (masked) |
createApiKey | Create a new API key (full key returned once) |
regenerateApiKey | Regenerate by id (old key invalidated immediately) |
deleteApiKey | Permanently delete an API key |
addLicenseIp | Whitelist an IP on an IP-mode license |
removeLicenseIp | Remove a whitelisted IP |
regenerateLicenseKey | Rotate a license’s RPC key |
Биллинг
| Tool | What it does |
|---|
prepareTopUp | Build an unsigned USDC top-up transaction |
confirmTopUp | Submit the signed top-up; OrbitFlare verifies on-chain and credits balance |
listInvoices | Paginated invoice list |
purchaseRpcPlan | Purchase or validateOnly-dry-run a plan from your account balance |
Стриминг, стейкинг, своп
| Tool | What it does |
|---|
subscribeTransactions | Build a ready-to-use Jetstream or Yellowstone gRPC config for the OrbitFlare CLI |
getStakeInfo | OrbitFlare validator identity, vote account, commission, est. APY, optional reward calculator |
getSwapQuote | Jupiter Metis routing quote (auto-resolves SOL / USDC / USDT symbols) |
Кошелёк и запись
| Tool | What it does |
|---|
generateKeypair | Generate Ed25519 keypair, optionally persist to ~/.orbitflare/mcp-keypair.json |
loadKeypair | Load from base58 secret or Solana CLI keypair file |
clearKeypair | Remove from session (and optionally disk) |
getWalletAddress | Returns the loaded wallet’s address |
signMessage | Ed25519-sign an arbitrary message (utf8 / base58 / base64) |
buildSolTransfer | Build an unsigned versioned tx transferring SOL |
buildStakeDelegation | Build an unsigned tx delegating to OrbitFlare’s vote account (or any vote account) |
signAndSendTransaction | Sign with the session keypair, broadcast via OrbitFlare RPC |
Сценарии
Аутентификация (device code)
Запрос device code
requestDeviceCode возвращает verification_uri + user_code. Модель показывает их вам.
Подтвердите в браузере, затем poll
pollDeviceToken { device_code } повторяется каждые interval секунд до успеха. Bearer-токен сохраняется автоматически и используется для следующих вызовов Customer API.
Выход
revokeToken очищает Bearer-токен.
Аутентификация (кошелёк)
Загрузка keypair
generateKeypair (создать новый) или loadKeypair (из base58 / файла Solana CLI).
Запрос challenge
requestWalletChallenge { wallet_address }.
Подпись и проверка
signMessage { message: <challenge> } затем verifyWalletSignature (существующий аккаунт) или registerWithWallet (новый аккаунт).
Отправка с кошелька
Загрузка keypair
generateKeypair или loadKeypair.
Сборка перевода
buildSolTransfer { recipient, amountSol } возвращает unsigned tx в base64.
Подпись и broadcast
signAndSendTransaction { transaction } подписывает keypair сессии, отправляет и возвращает подпись + ссылку Solscan.
Пополнение
Подготовка top-up
prepareTopUp { amount, wallet_address } возвращает unsigned USDC-transfer + memo в base64.
Подпись
Подпишите загруженным кошельком через signAndSendTransaction или извне.
Подтверждение
confirmTopUp { transaction: <signed-base64> }. OrbitFlare проверяет ончейн и зачисляет баланс.
Ресурсы
Сервер открывает документацию OrbitFlare как MCP resources — модель может подгружать актуальные страницы по запросу:
| URI | Page |
|---|
orbitflare://docs/index | Documentation index (llms.txt) |
orbitflare://docs/quickstart | Quickstart |
orbitflare://docs/authentication | Auth, endpoints, rate limits, connection limits |
orbitflare://docs/products | Products & pricing |
orbitflare://docs/rpc-http | HTTP RPC reference |
orbitflare://docs/jetstream | Jetstream streaming |
orbitflare://docs/yellowstone | Yellowstone gRPC |
orbitflare://docs/staking | Validator staking |
orbitflare://docs/metis-swap | Metis Swap API |
orbitflare://docs/cli | OrbitFlare CLI |
orbitflare://docs/customer-api | Customer API v2 |
Системные промпты
Готовые system / developer prompts лежат в каталоге system-prompts/orbitflare/:
claude.system.md: краткий системный промпт для Claude
openai.developer.md: краткое developer-сообщение для моделей OpenAI
full.md: развёрнутый операторский playbook (auth, top-up, жёсткие ограничения)
Добавьте один в конфиг хоста, чтобы модель знала, когда какой инструмент использовать.
Попробуйте
После установки модель сама подберёт инструмент:
“What is the SOL balance of Gh9ZwEm…?”
“Show me the last 20 transactions for 7xKXt….”
“What’s a competitive priority fee right now for an account that touches Raydium?”
“Build me a Yellowstone gRPC config that streams Jupiter swap transactions from Frankfurt.”
“Quote 1 SOL → USDC with 0.3% slippage.”
“What is OrbitFlare’s validator vote account, and what would 250 SOL earn per year?”
Источники