Orderly MCP

有序网络MCP服务器

一个模型上下文协议（MCP）服务器，为Orderly Network提供文档和SDK模式，Orderly Network是一个全链的永久期货交易基础设施。

快速开始

使用一个命令为您的AI客户端安装MCP服务器：

npx @orderly.network/mcp-server init --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网络？”_

______________________________________________________________________

此服务器提供什么

此MCP服务器使AI助手能够回答有关Orderly Network的问题，并指导开发人员使用Orderly SDK v2构建React组件。

特性

• 文档搜索：查询Orderly文档以了解架构、API和概念
• SDK模式：获取所有v2钩子的代码示例（useOrderEntry、usePositionStream等）
• 合同地址：查找所有受支持链的智能合约地址
• 工作流程指南：逐步解释常见开发任务
• 组件指南：构建交易UI组件的模式
• API 参考：REST和WebSocket端点文档
• 索引器API：交易指标、账户事件、交易量统计和排名

安装

快速安装（推荐）

使用CLI自动配置您的AI客户端：

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

可用客户端：

手动设置

如果您更喜欢手动配置或自动设置不适用于您的客户端：

先决条件

• Node.js 18或更高版本
• Yarn（或npm）

从源安装

1. 克隆或创建项目:

cd orderly-mcp

1. 安装依赖项:

yarn install

1. 构建项目:

yarn build

托管服务器

公开托管的实例可在以下网址获得 https://mcp.orderly.network.

健康检查：

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

在MCP客户端配置中使用（流式HTTP）：

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

运行服务器

MCP服务器支持两种模式：

1.标准模式（默认-适用于本地MCP客户端）

将此用于本地AI助手：

yarn start

手动配置

如果不使用自动安装程序，请将此配置添加到您的AI客户端：

克劳德代码 (.mcp.json):

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

光标 (.cursor/mcp.json):

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

VS代码 (.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/config.toml):

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

2.HTTP模式（用于自托管部署）

作为HTTP服务器运行以进行远程访问：

yarn start:http

服务器将在端口3000上启动（或 PORT env 是：

• 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）

查询示例:

• “保险库是如何工作的”
• “交易费”
• “订单类型”
• “杠杆计算”

2. get_sdk_pattern

获取Orderly SDK v2挂钩的代码示例和模式，并完成DEX组件。

参数:

• pattern （字符串，必填）：钩子或模式名称（例如，“useOrderEntry”、“钱包连接”、“轻量级图表”）
• includeExample （boolean，可选）：包含完整的代码示例（默认值：true）

可用图案:

• 账户: useAccount, useWalletConnector
• 订单: useOrderEntry, useOrderStream
• 职位: usePositionStream, useCollateral
• 市场数据: useOrderbookStream, useMarkPrice, useTickerStream
• 链条: useChains
• 资产: useDeposit
• 图表: LightweightChart, TradingViewWidgetSetup, Real-timeKlineDataviaWebSocket
• 交易组件: CreateOrder, Orderbook, SymbolHeader, SymbolSelection
• 定位组件: Positions, UpdatePosition, ClosePosition
• 钱包组件: ConnectWalletButton, WalletConnection, EvmDropdownMenu
• WebSocket服务: websocket.service （实时临床数据）

3. get_contract_addresses

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

参数:

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

支持的链:

• EVM：以太坊、仲裁机制、乐观主义、基础、地幔、solana
• 有序L2：有序L2

4. explain_workflow

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

参数:

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

可用工作流:

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

5. get_api_info

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

参数:

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

6. get_indexer_api_info

获取有关Orderly Indexer API的信息，用于交易指标、账户事件、交易量统计和排名。

参数:

• endpoint （字符串，可选）：特定端点路径或名称（例如，'/events_v2'、'daily_volume'、'ranking/positions'）
• category （字符串，可选）：按类别筛选（例如，“trading_metrics”、“events”、“ranking”）

可用类别:

• 交易指标：每日交易量、费用、每笔交易数据(/daily_volume, /daily_trading_fee, /daily_orderly_perp)
• 事件：带分页的帐户事件(/events_v2)-交易、结算、清算、交易
• 数量统计：账户和经纪商交易量统计(/get_account_volume_statistic, /get_broker_volume_statistic)
• 排名：头寸、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"

7. get_component_guide

获取使用Orderly SDK构建React UI组件的指导。

参数:

• component （字符串，必填）：组件类型
• complexity （字符串，可选）：“最小”、“标准”或“高级”（默认值：“标准”）

可用组件:

• order-entry：下单表格
• orderbook：市场深度显示
• positions：岗位管理表
• wallet-connector：钱包连接UI

8. get_orderly_one_api_info

获取有关Orderly One API的信息，用于DEX的创建、毕业和管理。

参数:

• endpoint （字符串，可选）：特定端点路径或名称（例如，“/dex”、“verify tx”、“/theme/modify”）
• category （字符串，可选）：按类别筛选（例如，“auth”、“dex”、“graduation”、“theme”、“stats”、“排行榜”、“admin”）

可用类别:

• 认证：基于钱包签名的身份验证（随机数、验证、确认）
• 德克斯：DEX管理-创建、更新、删除、部署和管理交换
• 毕业：毕业系统-从演示升级到完全经纪人，费用分成
• 主题：AI驱动的主题生成和CSS定制
• 统计：全平台统计和分析
• 排行榜：DEX排名、绩效指标和排行榜
• 管理员：平台管理的行政操作

示例:

# 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 -搜索索引器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 get_sdk_pattern with pattern "useOrderEntry"
→ Returns hook documentation with usage example

查找合同

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. 有序文件：架构、概念和指南
2. SDK模式：v2钩子示例和模式来自@orderly.network/hocks
3. DEX示例：完整的工作部件 示例dex 仓库
4. 合同地址：跨受支持链部署的所有合同
5. API规范：REST和WebSocket端点
6. 索引器API：交易指标、账户事件、交易量统计和排名
7. 有序一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        # Documentation search
│   │   ├── sdkPatterns.ts       # SDK pattern lookup
│   │   ├── 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
│   ├── resources/
│   │   └── index.ts             # Resource handlers
│   └── data/
│       ├── documentation.json   # Searchable documentation chunks
│       ├── sdk-patterns.json    # SDK patterns and examples
│       ├── 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
│       ├── 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文件 -当重新生成脚本运行时，它们将被覆盖。

先决条件

1. NEAR AI API密钥 .env 文件： NEAR_AI_API_KEY=your_key
2. 获取API密钥的位置：https://cloud.near.ai/api-keys

完全再生（推荐）

从头开始生成一切：

# 1. Download latest official docs
curl -o llms-full.txt https://orderly.network/docs/llms-full.txt

# 2. Split Telegram export (if you have one)
node scripts/split_telegram_chats.js

# 3. Analyze Telegram chats → tg_analysis.json
node scripts/analyze_chat_openai.js

# 4. Analyze docs → docs_analysis.json
node scripts/analyze_llms_full.js

# 5. Get SDK patterns from source (FREE - no AI calls)
node scripts/analyze_sdk.js

# 6. Get DEX examples from example-dex repo
# Option A: Basic (FREE - no AI calls)
git clone --depth 1 https://github.com/orderlynetwork/example-dex.git /tmp/example-dex
node scripts/analyze_example_dex.js
node scripts/enrich_sdk_patterns_with_examples.js

# Option B: AI-Enhanced (~$1-3, better documentation)
# git clone --depth 1 https://github.com/orderlynetwork/example-dex.git /tmp/example-dex
# node scripts/analyze_example_dex.js
# USE_AI=true node scripts/enrich_sdk_patterns_with_examples.js

# 7. Generate documentation and workflows
node scripts/generate_mcp_data.js

# 8. Generate API docs from OpenAPI spec
node scripts/generate_api_from_openapi.js

# 9. Generate Indexer API docs from OpenAPI spec
node scripts/generate_indexer_api.js

# 10. Generate Orderly One API docs from OpenAPI spec
node scripts/generate_orderly_one_api.js

# 11. Generate contract addresses
node scripts/generate_contracts.js

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

仅更新文档

如果您只想从没有Telegram数据的官方文档中刷新：

# 1. Download latest docs
curl -o llms-full.txt https://orderly.network/docs/llms-full.txt

# 2. Analyze docs only
node scripts/analyze_llms_full.js

# 3. Generate (will use existing tg_analysis.json if present)
node scripts/generate_mcp_data.js

# 4. Build
yarn build

数据文件

贡献

要添加新内容，您需要更新源数据并重新生成：

1. 新文档：更新 llms-full.txt 或Telegram导出，然后运行生成脚本
2. 新的SDK模式：SDK会从GitHub自动解析-SDK更新时会自动显示模式
3. 新的DEX示例：克隆 示例dex 回购并运行分析脚本
4. 新链条：更新源文档，然后重新生成
5. 新建工作流：添加到源文档或Telegram聊天，然后重新生成

许可证

麻省理工学院

支持

• 有序文件：https://orderly.network/docs
• SDK存储库：https://github.com/OrderlyNetwork/js-sdk
• 秩序混乱：https://discord.gg/OrderlyNetwork