> ## 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.

# 概述

> 在 OrbitFlare 上构建 AI 智能体：技能、MCP 服务器、CLI 与 SDK —— 智能体查询 Solana、流式传输数据与管理 OrbitFlare 账户所需的全部能力。

OrbitFlare 提供面向 Solana 的完整智能体能力面。将技能放入 Claude Code 或 Cursor，在任何兼容主机中接入 MCP 服务器，通过 Shell 调用 CLI，或直接使用 Rust SDK。四者共用同一套针对 Shredstream 优化的 RPC、gRPC 流式传输与客户 API。

<Tip>
  **从 MCP 服务器开始。** 它公开 53 个类型化工具，覆盖 RPC 读取、流式配置、账户管理、计费、兑换与链上钱包操作，并可在 Claude Desktop、Claude Code、Cursor、Windsurf、VS Code、Gemini CLI 与 Codex CLI 中开箱即用。
</Tip>

## 可用能力

<CardGroup cols={2}>
  <Card title="技能" icon="sparkles" href="/cn/agents/skills">
    可嵌入的指令集，指导 Claude Code、Cursor 与 Codex 正确使用 OrbitFlare：RPC、流式传输、专属节点、交易 API、CLI 与 SDK 合一。
  </Card>

  <Card title="MCP 服务器" icon="plug" href="/cn/agents/mcp">
    53 个工具覆盖 RPC、流式传输、计费、兑换、质押与钱包操作。可在任意兼容 MCP 的主机中使用，含身份验证流程、充值与文档资源。
  </Card>

  <Card title="CLI" icon="terminal" href="/cn/agents/cli">
    单一二进制：流式传输、查询、脚手架与账户管理。每条命令支持 `--json`，便于在 Shell 脚本与 CI/CD 中解析输出。
  </Card>

  <Card title="Rust SDK" icon="rust" href="/cn/agents/sdk">
    面向 RPC、WebSocket、Yellowstone gRPC 与 Jetstream 的类型化 Rust 客户端。内置重试、故障转移与重连，从环境变量读取端点。
  </Card>
</CardGroup>

## 技能 vs MCP vs CLI vs SDK

按工作流选择界面：

| 界面      | 最适合                                              | 何时选用                                                          |
| ------- | ------------------------------------------------ | ------------------------------------------------------------- |
| **技能**  | 编写 OrbitFlare 代码的编码智能体（Claude Code、Cursor、Codex） | 希望智能体在**编写**正确的 OrbitFlare 代码（端点 URL、gRPC 过滤器、SDK 设置）时无需你先查文档 |
| **MCP** | 需要**从对话中直接调用** OrbitFlare 的智能体                   | 希望智能体查询余额、发送交易、构建流式配置或通过对话管理账户                                |
| **CLI** | Shell 脚本、CI/CD、终端自动化                             | 编写 bash、GitHub Actions 或 cron，且 `--json` 输出可与 `jq` 和管道良好组合    |
| **SDK** | 生产级 Rust 服务                                      | 构建长期运行的守护进程、索引器或交易机器人，需要类型安全访问并内置重试/故障转移                      |

<Note>
  技能与 MCP 互补。两者都安装：技能教智能体 *OrbitFlare 如何工作*；MCP 服务器让它无需离开对话即可实际调用 OrbitFlare。
</Note>

## 推荐配置

在 Solana 上为编码智能体搭建的最快路径：

<Steps>
  <Step title="获取 API 密钥">
    在 [orbitflare.com](https://orbitflare.com) 注册，从控制台的 **Licenses（许可证）** 部分复制许可证密钥。免费方案永久提供 10 RPS / 1 TPS。
  </Step>

  <Step title="安装技能">
    ```bash theme={null}
    npx @orbitflare/skills@latest      # Claude Code（个人）
    ```

    Cursor、Codex 与项目级安装见 [技能](/cn/agents/skills)。
  </Step>

  <Step title="安装 MCP 服务器">
    添加到主机的 MCP 配置：

    ```json theme={null}
    {
      "mcpServers": {
        "orbitflare": {
          "command": "npx",
          "args": ["@orbitflare/mcp@latest"],
          "env": {
            "ORBITFLARE_API_KEY": "your-license-key",
            "ORBITFLARE_NETWORK": "mainnet"
          }
        }
      }
    }
    ```

    各主机文件路径与 Codex CLI 的 TOML 变体见 [MCP 服务器](/cn/agents/mcp)。
  </Step>

  <Step title="重启主机">
    重启 Claude Code（或你所用主机），以加载新技能与 MCP 服务器。
  </Step>

  <Step title="试一条提示">
    > 「使用 OrbitFlare Jetstream 从法兰克福流式传输 pump.fun 交易」

    > 「`Gh9ZwEm…` 的 SOL 余额是多少？然后显示该地址最近 20 笔交易。」

    > 「以 0.3% 滑点报价 1 SOL → USDC，并为我生成监视该池的 Yellowstone 配置。」
  </Step>
</Steps>

## 常见工作流

| 目标         | 使用的界面                                                                      |
| ---------- | -------------------------------------------------------------------------- |
| 构建交易机器人    | **MCP** 在对话中原型设计 → **Rust SDK** 用于生产守护进程                                   |
| 流式实时数据     | **MCP** 的 `subscribeTransactions` 生成 YAML → **CLI** `orbitflare stream` 运行 |
| 索引历史数据     | **技能** 学习 `getTransactionsForAddress` 与归档端点 → **SDK** 编写索引器                |
| 管理账户 / 计费  | **MCP** 身份验证流程 + 对话中的 `prepareTopUp` / `confirmTopUp`                      |
| 兑换报价       | **MCP** `getSwapQuote`（Jupiter Metis 路由，自动解析 SOL/USDC/USDT 符号）             |
| CI / 脚本自动化 | 带 `--json` 的 **CLI** 管道接入 `jq`                                             |

## 源代码

均为开源：

* 技能：[github.com/orbitflare/orbitflare-skills](https://github.com/orbitflare/orbitflare-skills)
* MCP 服务器：[github.com/orbitflare/orbitflare-mcp](https://github.com/orbitflare/orbitflare-mcp)
* CLI：[github.com/orbitflare/orbit-cli](https://github.com/orbitflare/orbit-cli)
* Rust SDK：[github.com/orbitflare/orbitflare-sdk-rs](https://github.com/orbitflare/orbitflare-sdk-rs)

智能体能力面源自同一事实来源：[docs.orbitflare.com/llms.txt](https://docs.orbitflare.com/llms.txt)。若希望智能体基于官方文档回答，可将任意智能体指向该索引。