Orderly Network Mcp Server

Orderly Network MCP 服务

一个 Model Context Protocol（MCP）服务，提供 Orderly Network 的文档和 SDK 模式。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 组件。

功能

• 文档搜索：查询 Orderly 文档中的架构、API 和概念
• SDK 模式：获取所有 v2 hook 的代码示例（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 服务支持两种模式：

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（字符串，必填）：关于 Orderly 的搜索查询
• limit（数字，可选）：最多返回的结果数（默认值：5）

示例查询：

• “金库如何运作”
• “交易手续费”
• “订单类型”
• “杠杆计算”

SDK 符号（钩子、类型、组件、函数）现在会由 search_orderly_docs 内联显示 — 请参阅下文的 SDK 符号搜索。

2. get_contract_addresses

获取特定链上 Orderly 的智能合约地址。

参数：

• chain（字符串，必填）：链名称（例如：'arbitrum'、'optimism'、'base'）
• contractType（字符串，可选）：合约类型或 'all'（默认值：'all'）
• network（字符串，可选）：'mainnet' 或 'testnet'（默认值：'mainnet'）

支持的链：

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

3. explain_workflow

获取常见开发工作流的分步说明。

参数：

• workflow（字符串，必填）：工作流名称

可用工作流：

• wallet-connection：连接钱包并创建 Orderly 密钥
• place-first-order：完成首次交易的完整流程
• deposit-funds：向 Orderly 存入 USDC/代币
• set-tp-sl：设置止盈和止损
• subaccount-management：创建和管理子账户

4. get_api_info

获取 Orderly REST API 或 WebSocket 流的信息。

参数：

• type（字符串，必填）：'rest'、'websocket' 或 'auth'
• endpoint（字符串，可选）：特定端点或流名称

5. get_indexer_api_info

获取 Orderly Indexer API 的信息，包括交易指标、账户事件、交易记录和成交量统计（可通过端点搜索查找排名端点）。

参数：

• endpoint（字符串，可选）：特定端点路径或名称（例如：'/events_v2'、'daily_volume'、'ranking/positions'）
• category（字符串，可选）：按类别筛选（例如：'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）

排名（无类别；按端点搜索）：

• 持仓、盈亏、交易量、存款/取款（/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（字符串，必填）：组件类型
• complexity（字符串，可选）：'minimal'、'standard' 或 'advanced'（默认值：'standard'）

可用组件：

• order-entry：下单表单
• orderbook：市场深度显示
• positions：持仓管理表格
• wallet-connector：钱包连接界面

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 Hooks
• 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 文档：架构、概念和指南
2. SDK 模式：来自 @orderly.network/hooks 的 v2 Hook 示例和模式
3. DEX 示例：example-dex 仓库中的完整可运行组件
4. 合约地址：所有受支持链上已部署的合约
5. API 规范：REST 和 WebSocket 端点
6. Indexer API：交易指标、账户事件、交易和交易量统计
7. Orderly One API：DEX 创建、毕业和管理 API 文档
8. 工作流指南：常见开发任务说明

项目结构

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 文档：https://orderly.network/docs
• SDK 仓库：https://github.com/OrderlyNetwork/js-sdk
• Orderly Discord：https://discord.gg/OrderlyNetwork