Orderly Network Mcp Server

Orderly Network MCP サーバー

Orderly Network 向けのドキュメントと SDK のパターンを提供する Model Context Protocol（MCP）サーバーです。Orderly Network は、オムニチェーン対応の無期限先物取引インフラストラクチャです。

クイックスタート

次のコマンドを実行して、AI クライアントに MCP サーバーをインストールします。

npx @orderly.network/mcp-server init --client <client>

対応クライアント： claude、cursor、vscode、codex、opencode

使用例

# OpenCode
npx @orderly.network/mcp-server init --client opencode

# Claude Code
npx @orderly.network/mcp-server init --client claude

# Cursor
npx @orderly.network/mcp-server init --client cursor

# VS Code (with Copilot)
npx @orderly.network/mcp-server init --client vscode

# Interactive mode (prompts for client selection)
npx @orderly.network/mcp-server init

このコマンドは、次の処理を行います。

1. AI クライアントに適した設定ファイルを作成します
2. @orderly.network/mcp-server を開発依存関係としてインストールします
3. 次の手順を案内します

インストール後： AI クライアントを再起動し、「Orderly Network にはどう接続すればよいですか？」と尋ねてみてください。

---

このサーバーが提供する機能

この MCP サーバーを使うと、AI アシスタントが Orderly Network に関する質問に答え、Orderly SDK v2 を使用した React コンポーネントの構築を開発者に案内できます。

機能

• ドキュメント検索：アーキテクチャ、API、概念に関する Orderly のドキュメントを検索します
• SDK パターン：すべての v2 フック（useOrderEntry、usePositionStream など）のコード例を取得します
• コントラクトアドレス：サポート対象のすべてのチェーンのスマートコントラクトアドレスを検索します
• ワークフローガイド：一般的な開発タスクを手順ごとに説明します
• コンポーネントガイド：取引 UI コンポーネントの構築パターンを紹介します
• API リファレンス：REST と WebSocket のエンドポイントに関するドキュメントを提供します
• インデクサー API：取引指標、アカウントイベント、取引、出来高統計を提供します

インストール

クイックインストール（推奨）

CLI を使って AI クライアントを自動的に設定します。

npx @orderly.network/mcp-server init --client <client>

利用可能なクライアント：

クライアント	コマンド	設定場所
Claude Code	--client claude	.mcp.json
Cursor	--client cursor	.cursor/mcp.json
VS Code	--client vscode	.vscode/mcp.json
Codex	--client codex	~/.codex/config.toml
OpenCode	--client opencode	.opencode/mcp.json

手動セットアップ

手動で設定する場合、または自動セットアップがクライアントで機能しない場合は、次の手順に従ってください。

前提条件

• Node.js 18 以上
• Yarn（または npm）

ソースからのセットアップ

1. プロジェクトをクローンまたは作成します：

cd orderly-mcp

2. 依存関係をインストールします：

yarn install

3. プロジェクトをビルドします：

yarn build

ホストサーバー

一般公開されているインスタンスを https://mcp.orderly.network で利用できます。

ヘルスチェック：

curl https://mcp.orderly.network/health

MCP クライアント設定での使用（Streamable HTTP）：

{
  "mcpServers": {
    "orderly": {
      "url": "https://mcp.orderly.network/"
    }
  }
}

サーバーの実行

MCP サーバーは、次の 2 つのモードに対応しています。

1. Stdio モード（デフォルト — ローカルの MCP クライアント向け）

ローカルの AI アシスタントでは、次のように使用します。

yarn start

手動設定

自動インストーラーを使用しない場合は、次の設定を AI クライアントに追加します。

Claude Code（.mcp.json）：

{
  "mcpServers": {
    "orderly": {
      "command": "npx",
      "args": ["@orderly.network/mcp-server@latest"]
    }
  }
}

Cursor（.cursor/mcp.json）：

{
  "mcpServers": {
    "orderly": {
      "command": "npx",
      "args": ["@orderly.network/mcp-server@latest"]
    }
  }
}

VS Code（.vscode/mcp.json）：

{
  "servers": {
    "orderly": {
      "command": "npx",
      "args": ["@orderly.network/mcp-server@latest"]
    }
  }
}

OpenCode（.opencode/mcp.json）：

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "orderly": {
      "type": "local",
      "command": ["npx", "@orderly.network/mcp-server@latest"],
      "enabled": true
    }
  }
}

Codex（~/.codex/config.toml）：

[mcp_servers.orderly]
command = "npx"
args = ["@orderly.network/mcp-server@latest"]

2. HTTP モード（セルフホストでのデプロイ向け）

リモートアクセス用に HTTP サーバーとして実行します。

yarn start:http

サーバーはポート 3000（または PORT 環境変数で指定したポート）で起動します。

• MCP エンドポイント：http://localhost:3000/
• ヘルスチェック：http://localhost:3000/health

注： 一般公開インスタンスはすでに https://mcp.orderly.network にデプロイされています。上記のホストサーバーをご覧ください。

Docker でのデプロイ：

# Build the image
docker build -t orderly-mcp .

# Run the container
docker run -p 3000:3000 orderly-mcp

Docker イメージはデフォルトでステートレス HTTP モードで実行されます。

開発

自動再ビルドを有効にして開発する場合：

yarn dev

コード品質

このプロジェクトでは、コード品質の維持に ESLint と Prettier を使用しています。

# Run linting
yarn lint

# Fix linting issues
yarn lint:fix

# Format code
yarn format

# Check formatting
yarn format:check

# Type check
yarn typecheck

利用可能なツール

1. search_orderly_docs

特定のトピック、概念、質問について Orderly のドキュメントを検索します。

パラメーター:

• query（string、必須）：Orderly に関する検索クエリ
• limit（number、任意）：結果の最大数（デフォルト：5）

クエリの例:

• "ボールトの仕組み"
• "取引手数料"
• "注文タイプ"
• "レバレッジの計算"

SDK シンボル（フック、型、コンポーネント、関数）は、search_orderly_docs の検索結果にインラインで表示されるようになりました。詳しくは、以下のSDK シンボル検索をご覧ください。

2. get_contract_addresses

特定のチェーンにおける Orderly のスマートコントラクトアドレスを取得します。

パラメーター:

• chain（string、必須）：チェーン名（例：'arbitrum'、'optimism'、'base'）
• contractType（string、任意）：コントラクトの種類、または 'all'（デフォルト：'all'）
• network（string、任意）：'mainnet' または 'testnet'（デフォルト：'mainnet'）

対応チェーン:

• EVM：ethereum、arbitrum、optimism、base、mantle、solana
• Orderly L2：orderlyL2

3. explain_workflow

一般的な開発ワークフローについて、手順を追った説明を取得します。

パラメーター:

• workflow（string、必須）：ワークフロー名

利用可能なワークフロー:

• wallet-connection：ウォレットを接続し、Orderly キーを作成する
• place-first-order：初回取引を行うまでの一連の手順
• deposit-funds：USDC／トークンを Orderly に入金する
• set-tp-sl：テイクプロフィットとストップロスを設定する
• subaccount-management：サブアカウントを作成、管理する

4. get_api_info

Orderly REST API または WebSocket ストリームの情報を取得します。

パラメーター:

• type（string、必須）：'rest'、'websocket'、または 'auth'
• endpoint（string、任意）：特定のエンドポイントまたはストリーム名

5. get_indexer_api_info

取引指標、アカウントイベント、取引、出来高統計に関する Orderly Indexer API の情報を取得します（ランキングのエンドポイントはエンドポイント検索で利用できます）。

パラメーター:

• endpoint（string、任意）：特定のエンドポイントパスまたは名前（例：'/events_v2'、'daily_volume'、'ranking/positions'）
• category（string、任意）：カテゴリで絞り込みます（例：'trading_metrics'、'events::events_api'、'trades::trades_api'）

利用可能なカテゴリ:

• 取引指標：日次出来高、手数料、無期限先物の取引データ（/daily_volume、/daily_trading_fee、/daily_orderly_perp）
• イベント：ページネーション対応のアカウントイベント（/events_v2）- 取引、決済、清算、トランザクション
• 出来高統計：アカウントとブローカーの出来高統計（/get_account_volume_statistic、/get_broker_volume_statistic）
• 取引：フィルター付きの取引データ（/trades）

ランキング（カテゴリなし。エンドポイントで検索）:

• ポジション、PnL、取引出来高、入出金（/ranking/positions、/ranking/realized_pnl、/ranking/trading_volume、/ranking/deposit、/ranking/withdraw）

例:

# Get all indexer API endpoints
get_indexer_api_info

# Get specific endpoint details
get_indexer_api_info endpoint="/events_v2"

# Get all endpoints in a category
get_indexer_api_info category="trading_metrics"

6. get_component_guide

Orderly SDK を使用して React UI コンポーネントを構築するためのガイダンスを取得します。

パラメーター:

• component（string、必須）：コンポーネントの種類
• complexity（string、任意）：'minimal'、'standard'、または 'advanced'（デフォルト：'standard'）

利用可能なコンポーネント:

• order-entry：注文発注フォーム
• orderbook：市場の板情報の表示
• positions：ポジション管理テーブル
• wallet-connector：ウォレット接続 UI

7. get_orderly_one_api_info

DEX の作成、グラデュエーション、管理に関する Orderly One API の情報を取得します。

パラメーター：

• endpoint（文字列、任意）：特定のエンドポイントパスまたは名前（例：'/dex'、'verify-tx'、'/theme/modify'）
• category（文字列、任意）：カテゴリーで絞り込みます（例：'auth'、'dex'、'graduation'、'theme'、'stats'、'leaderboard'、'admin'）

利用可能なカテゴリー：

• auth：ウォレット署名ベースの認証（nonce、verify、validate）
• dex：DEX 管理 — 取引所の作成、更新、削除、デプロイ、管理
• graduation：グラデュエーションシステム — 手数料の分配を伴い、デモから完全なブローカーへアップグレード
• theme：AI を活用したテーマ生成と CSS のカスタマイズ
• stats：プラットフォーム全体の統計と分析
• leaderboard：DEX のランキング、パフォーマンス指標、リーダーボード
• admin：プラットフォーム管理のための管理操作

例：

# Get overview and authentication flow
get_orderly_one_api_info

# Get all endpoints in a category
get_orderly_one_api_info category="dex"
get_orderly_one_api_info category="graduation"

# Get specific endpoint details
get_orderly_one_api_info endpoint="verify-tx"
get_orderly_one_api_info endpoint="/theme/modify"

利用可能なリソース

リソース URI を使用して包括的なドキュメントにアクセスできます。すべてのリソースは、ページネーション付きのあいまい検索に対応しています。

クエリパラメーター：

• search（必須）- あいまい検索クエリ
• page（任意）- ページ番号（デフォルト：1）
• limit（任意）- ページあたりの結果数、最大 10（デフォルト：10）

リソース：

• orderly://overview - プロトコルアーキテクチャの概要（検索不要）
• orderly://sdk/hooks?search=orderEntry - 名前、説明、カテゴリーで SDK フックを検索
• orderly://sdk/components?search=Checkbox - 名前または説明でコンポーネントを検索
• orderly://contracts?search=arbitrum - チェーンまたは名前でコントラクトを検索
• orderly://workflows?search=wallet - 名前または手順でワークフローを検索
• orderly://api/rest?search=position - REST API エンドポイントを検索
• orderly://api/websocket?search=orderbook - WebSocket ストリームを検索
• orderly://api/indexer?search=events - Indexer API エンドポイントを検索

例：

orderly://sdk/hooks?search=useOrderEntry&page=1&limit=5

使用例

ドキュメントの検索

User: "How does Orderly's vault system work?"

AI uses search_orderly_docs with query "vault system"
→ Returns explanation of cross-chain vault architecture

SDK シンボルの検索

User: "Show me how to use useOrderEntry"

AI uses search_orderly_docs with query "useOrderEntry"
→ Returns inline SDK hook record: signature, params, returns, source path

コントラクトの参照

User: "What's the USDC address on Arbitrum?"

AI uses get_contract_addresses with chain "arbitrum", contractType "USDC"
→ Returns contract address

ワークフローの説明

User: "How do I place my first order?"

AI uses explain_workflow with workflow "place-first-order"
→ Returns step-by-step guide

コンポーネント構築ガイド

User: "How do I build an order entry component?"

AI uses get_component_guide with component "order-entry"
→ Returns complete implementation guide

データソース

この MCP サーバーには、以下のデータが組み込まれています。

1. Orderly Documentation：アーキテクチャ、概念、ガイド
2. SDK Patterns：@orderly.network/hooks の v2 フックの例とパターン
3. DEX Examples：example-dex リポジトリの、動作する完全なコンポーネント
4. Contract Addresses：サポート対象チェーン全体にデプロイされたすべてのコントラクト
5. API Specifications：REST および WebSocket エンドポイント
6. Indexer API：取引指標、アカウントイベント、取引、取引量の統計
7. Orderly One API：DEX の作成、グラデュエーション、管理 API のドキュメント
8. Workflow Guides：一般的な開発タスクの説明

プロジェクト構成

orderly-mcp/
├── src/
│   ├── index.ts                 # Main server entry (stdio mode)
│   ├── http-server.ts           # HTTP server entry (stateless mode)
│   ├── server.ts                # Shared MCP server logic
│   ├── tools/
│   │   ├── searchDocs.ts        # Unified doc + SDK symbol search
│   │   ├── contracts.ts         # Contract address lookup
│   │   ├── workflows.ts         # Workflow explanations
│   │   ├── apiInfo.ts           # API documentation
│   │   ├── indexerApi.ts        # Indexer API documentation
│   │   ├── componentGuides.ts   # Component building guides
│   │   ├── orderlyOneApi.ts     # Orderly One API documentation
│   │   ├── svApi.ts             # Strategy Vault API documentation
│   │   └── publicInfoApi.ts     # Public Info API documentation
│   ├── resources/
│   │   └── index.ts             # Resource handlers
│   └── data/
│       ├── documentation.json   # Searchable documentation chunks
│       ├── sdk-symbols.json     # Type-accurate SDK symbols (hooks/types/components/functions)
│       ├── contracts.json       # Contract addresses
│       ├── workflows.json       # Workflow explanations
│       ├── api.json             # API specifications
│       ├── indexer-api.json     # Indexer API documentation
│       ├── orderly-one-api.json # Orderly One API documentation
│       ├── sv-api.json          # Strategy Vault API documentation
│       ├── public-info-api.json # Public Info API documentation
│       ├── component-guides.json # Component guides
│       └── resources/
│           └── overview.md      # Protocol overview
├── .vscode/                     # VS Code settings
│   ├── settings.json
│   └── extensions.json
├── package.json
├── tsconfig.json
├── eslint.config.mjs            # ESLint configuration
├── .prettierrc                  # Prettier configuration
├── .gitignore
├── .dockerignore                # Docker ignore rules
├── Dockerfile                   # Docker build configuration
└── README.md

データの更新

src/data/ 内のすべてのデータファイルは、scripts/ フォルダー内のスクリプトによって自動生成されます。JSON ファイルを手動で編集しないでください。再生成スクリプトの実行時に上書きされます。

無料で素早く更新

OpenAPI をソースとするすべてのデータを更新します（AI 呼び出しなし、API キー不要、インターネット接続のみ）。

yarn update:free

以下を実行します：generate_api_from_openapi、generate_indexer_api、generate_sv_api、generate_contracts、generate_orderly_one_api。その後、ビルドとテストを実行します。

前提条件

1. .env ファイルに NEAR AI API キーを設定：NEAR_AI_API_KEY=your_key
2. API キーの取得先：https://cloud.near.ai/api-keys

完全な再生成（推奨）

すべてを一から生成します。

# 1. (Optional) Process Telegram export — 2 steps with manual review between
node scripts/clean_telegram_export.js    # 🆓 free, filter → telegram_chats_filtered/
# ...review + delete unwanted files manually...
node scripts/analyze_telegram_chats.js      # 💰 costs money → tg_analysis.json

# 2. Analyze docs → docs_analysis.json                                 💰 costs money
#    (clones OrderlyNetwork/documentation-public automatically)
node scripts/analyze_docs.js

# 3. Get type-accurate SDK symbols from npm                            🆓 free
node scripts/generate_sdk_symbols.js

# 4. Get component-building guides from SDK source                      🆓 free
node scripts/analyze_sdk.js

# 5. Generate documentation and workflows                              💰 costs money
node scripts/generate_mcp_data.js

# 6. Generate API docs from OpenAPI spec                               🆓 free
node scripts/generate_api_from_openapi.js

# 7. Generate Indexer API docs from OpenAPI spec                       🆓 free
node scripts/generate_indexer_api.js

# 8. Generate Orderly One API docs from OpenAPI spec                   🆓 free
node scripts/generate_orderly_one_api.js

# 9. Generate contract addresses                                       🆓 free
node scripts/generate_contracts.js

# 10. Build and test
yarn build && yarn test:run

ドキュメントのみを更新

公式ドキュメントから更新します（ソースとして git でクローンしたリポジトリを使用します）。

# 1. Analyze docs only (clones repo automatically)                     💰 costs money
node scripts/analyze_docs.js

# 2. Generate                                                           💰 costs money
node scripts/generate_mcp_data.js

# 3. Build
yarn build

データファイル

ファイル	ソース	生成スクリプト
documentation.json	公式ドキュメント（git: documentation-public）	generate_mcp_data.js
sdk-symbols.json	@orderly.network/sdk-docs npm パッケージ	generate_sdk_symbols.js
component-guides.json	SDK のソースコード（GitHub）	analyze_sdk.js
workflows.json	公式ドキュメント（git: documentation-public）	generate_mcp_data.js
api.json	OpenAPI 仕様	generate_api_from_openapi.js
indexer-api.json	Indexer API OpenAPI 仕様	generate_indexer_api.js
orderly-one-api.json	Orderly One OpenAPI 仕様	generate_orderly_one_api.js
sv-api.json	Strategy Vault OpenAPI 仕様	generate_sv_api.js
public-info-api.json	Public Info API MDX ドキュメント	generate_public_info_api.js
contracts.json	公式ドキュメント（Git: documentation-public）	generate_contracts.js

貢献

新しいコンテンツを追加するには、ソースデータを更新して再生成する必要があります。

1. 新しいドキュメント：documentation-public リポジトリ（または Telegram のエクスポート）を更新してから、生成スクリプトを実行します
2. 新しい SDK パターン：SDK は GitHub から自動的に解析されます。SDK の更新に合わせてパターンも自動的に反映されます
3. 新しい DEX の例：example-dex リポジトリをクローンして、分析スクリプトを実行します
4. 新しいチェーン：ソースドキュメントを更新してから、再生成します
5. 新しいワークフロー：ソースドキュメントまたは Telegram のチャットに追加してから、再生成します

ライセンス

MIT

サポート

• Orderly Documentation：https://orderly.network/docs
• SDK リポジトリ：https://github.com/OrderlyNetwork/js-sdk
• Orderly Discord：https://discord.gg/OrderlyNetwork