# Orbiter Skills — Usage Guide

### Repository

GitHub repository:

```txt
https://github.com/Orbiter-Finance/bridge-skills
```

***

### Overview

Orbiter Finance MCP + Skills + CLI is a toolkit for “one‑click cross‑chain” onboarding. It includes:

* MCP Server
* AI Skills (`skills/`)
* CLI
* Unified API SDK

***

### Installation

#### One‑Command Install

```bash
curl -fsSL https://raw.githubusercontent.com/Orbiter-Finance/bridge-skills/main/install.sh | sh()
```

#### Install via Skills CLI (If You Use It)

```bash
npx skills add Orbiter-Finance/bridge-skills
```

#### Client‑Specific Guides

Client setup guides are provided for:

* Codex
* OpenCode
* Cursor
* Claude
* OpenClaw

#### Supported MCP Clients

* Claude Code
* Cursor
* OpenClaw
* Any MCP‑compatible client (use stdio command)

***

### Environment Variables

Optional variables:

* `ORBITER_API_BASE_URL` (default `https://openapi.orbiter.finance`)
* `ORBITER_API_KEY`
* `ORBITER_PRIVATE_KEY` (only used for local signing in `bridge sign` / `bridge sign-broadcast`)

Security note: the private key is used only for local signing and is never written to disk or sent over the network. 

***

### MCP Tools

Available MCP tools:

* `orbiter_chains`
* `orbiter_tokens`
* `orbiter_bridge_quote`
* `orbiter_bridge_tx`
* `orbiter_bridge_flow`
* `orbiter_sign_template`
* `orbiter_sign_broadcast`
* `orbiter_transaction`
* `orbiter_wallet_portfolio`
* `orbiter_tx_simulate`
* `orbiter_tx_broadcast`
* `orbiter_rpc_health`

***

### Skills Documentation

Each Skill has its own `SKILL.md` and is the single source of truth for inputs, outputs, and examples. 

#### Skills Index

* `orbiter-bridge-flow`
* `orbiter-bridge-quote`
* `orbiter-bridge-tx`
* `orbiter-chain-status`
* `orbiter-chains`
* `orbiter-rpc-health`
* `orbiter-sign-broadcast`
* `orbiter-sign-template`
* `orbiter-tokens`
* `orbiter-transaction`
* `orbiter-tx-broadcast`
* `orbiter-tx-simulate`
* `orbiter-tx-track`
* `orbiter-wallet-portfolio`

#### Skills Conventions

* Each `SKILL.md` is the single source of truth.
* Inputs and outputs mirror MCP tool schemas.
* CLI examples use the `orbiter` binary.
* Quotes can include `approve`, `swap`, and `bridge` steps depending on route.
* `orbiter_bridge_flow` can auto‑approve when `autoApprove` and `privateKey` are provided.

***

### CLI — Common Commands

#### Chains and Tokens

```bash
orbiter chains
orbiter chains --raw
orbiter tokens --chain 42161 --prefix ETH
orbiter tokens --chain 42161 --prefix USDC --bridgeable --limit 5
```

#### Quote and Tx

```bash
orbiter bridge quote --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc...
orbiter bridge quote --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount-human 0.0006 --amount-decimals 18 --user 0xabc... --recipient 0xabc... --format summary
orbiter bridge tx --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc...
orbiter bridge tx --source-chain 42161 --dest-chain 42161 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0xaf88d065e77c8cc2239327c5edb3a432268e5831 --amount 600000000000000 --user 0xabc... --recipient 0xabc... --action swap
```

#### Flow (Quote + Signable Tx + Simulate)

```bash
orbiter bridge flow --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc... --chain 42161 --call-on-fail
orbiter bridge flow --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount-human 0.0006 --amount-decimals 18 --user 0xabc... --recipient 0xabc... --format summary
```

#### Auto‑Approve (If Allowance Is Insufficient)

```bash
ORBITER_PRIVATE_KEY=... orbiter bridge flow --source-chain 42161 --dest-chain 8453 --source-token 0x... --dest-token 0x... --amount 1000000 --user 0xabc... --recipient 0xabc... --chain 42161 --auto-approve
```

#### Same‑Chain Swap (ETH → USDC on Arbitrum)

```bash
orbiter bridge quote --source-chain 42161 --dest-chain 42161 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0xaf88d065e77c8cc2239327c5edb3a432268e5831 --amount 600000000000000 --user 0xabc... --recipient 0xabc...
```

#### Sign Template and Broadcast

```bash
orbiter bridge sign-template --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc... --chain 42161
orbiter bridge sign --template-file ./template.json --chain-id 42161
orbiter bridge sign-broadcast --template-file ./template.json --chain-id 42161 --chain 42161
```

#### RPC Health

```bash
orbiter rpc health --chain 42161
```

***

### Local Development

```bash
pnpm install
pnpm -r run build
pnpm -C mcp run dev
pnpm -C cli run dev -- bridge quote --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc...
pnpm -C cli run dev -- bridge tx --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc...
pnpm -C cli run dev -- bridge flow --source-chain 42161 --dest-chain 8453 --source-token 0x0000000000000000000000000000000000000000 --dest-token 0x0000000000000000000000000000000000000000 --amount 300000000000000 --user 0xabc... --recipient 0xabc... --chain 42161 --call-on-fail
```