Servidor MCP de Orderly Network

Un servidor del Protocolo de Contexto de Modelo (MCP) que proporciona documentación y patrones de SDK para Orderly Network, una infraestructura de trading de futuros perpetuos omnichain.

Inicio rápido

Instala el servidor MCP con un comando para tu cliente de IA:

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

Clientes compatibles: claude, cursor, vscode, codex, opencode

Ejemplos

# 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

Este comando:

1. Creará el archivo de configuración apropiado para tu cliente de IA

2. Instalará @orderly.network/mcp-server como una dependencia de desarrollo

3. Te guiará a través de los siguientes pasos

Después de la instalación: Reinicia tu cliente de IA e intenta preguntar: "¿Cómo me conecto a Orderly Network?"

Qué proporciona este servidor

Este servidor MCP permite a los asistentes de IA responder preguntas sobre Orderly Network y guiar a los desarrolladores en la creación de componentes de React utilizando el SDK v2 de Orderly.

Características

• Búsqueda de documentación: Consulta los documentos de Orderly para arquitectura, APIs y conceptos

• Patrones de SDK: Obtén ejemplos de código para todos los hooks de la v2 (useOrderEntry, usePositionStream, etc.)

• Direcciones de contratos: Busca direcciones de contratos inteligentes para todas las cadenas compatibles

• Guías de flujo de trabajo: Explicaciones paso a paso de tareas comunes de desarrollo

• Guías de componentes: Patrones para crear componentes de interfaz de trading

• Referencia de API: Documentación de endpoints REST y WebSocket

• API de Indexador: Métricas de trading, eventos de cuenta, estadísticas de volumen y clasificaciones

Instalación

Instalación rápida (Recomendado)

Usa la CLI para configurar automáticamente tu cliente de IA:

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

Clientes disponibles:

Configuración manual

Si prefieres configurar manualmente o la configuración automática no funciona para tu cliente:

Requisitos previos

• Node.js 18 o superior

• Yarn (o npm)

Configuración desde el código fuente

1. Clona o crea el proyecto:

cd orderly-mcp

2. Instala las dependencias:

yarn install

3. Compila el proyecto:

yarn build

Ejecución del servidor

El servidor MCP admite dos modos:

1. Modo Stdio (Predeterminado - para clientes MCP locales)

Úsalo para asistentes de IA locales:

yarn start

Configuración manual

Si no usas el instalador automático, añade esta configuración a tu cliente de IA:

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. Modo HTTP (para despliegues alojados)

Ejecuta como un servidor HTTP para acceso remoto:

yarn start:http

El servidor se iniciará en el puerto 3000 (o la variable de entorno PORT):

• Endpoint MCP: http://localhost:3000/

• Verificación de estado: http://localhost:3000/health

Despliegue en Docker:

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

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

La imagen de Docker se ejecuta en modo HTTP sin estado por defecto.

Desarrollo

Para desarrollo con reconstrucción automática:

yarn dev

Calidad del código

Este proyecto utiliza ESLint y Prettier para la calidad del código:

# Run linting
yarn lint

# Fix linting issues
yarn lint:fix

# Format code
yarn format

# Check formatting
yarn format:check

# Type check
yarn typecheck

Herramientas disponibles

1. search_orderly_docs

Busca en la documentación de Orderly temas, conceptos o preguntas específicas.

Parámetros:

• query (string, obligatorio): Consulta de búsqueda sobre Orderly

• limit (number, opcional): Resultados máximos (predeterminado: 5)

Ejemplos de consultas:

• "how does the vault work"

• "trading fees"

• "order types"

• "leverage calculation"

2. get_sdk_pattern

Obtén ejemplos de código y patrones para los hooks del SDK v2 de Orderly y componentes DEX completos.

Parámetros:

• pattern (string, obligatorio): Nombre del hook o patrón (ej., 'useOrderEntry', 'wallet-connection', 'LightweightChart')

• includeExample (boolean, opcional): Incluir ejemplo de código completo (predeterminado: true)

Patrones disponibles:

• Cuenta: useAccount, useWalletConnector

• Órdenes: useOrderEntry, useOrderStream

• Posiciones: usePositionStream, useCollateral

• Datos de mercado: useOrderbookStream, useMarkPrice, useTickerStream

• Cadenas: useChains

• Activos: useDeposit

• Gráficos: LightweightChart, TradingViewWidgetSetup, Real-timeKlineDataviaWebSocket

• Componentes de trading: CreateOrder, Orderbook, SymbolHeader, SymbolSelection

• Componentes de posición: Positions, UpdatePosition, ClosePosition

• Componentes de billetera: ConnectWalletButton, WalletConnection, EvmDropdownMenu

• Servicios WebSocket: websocket.service (datos kline en tiempo real)

3. get_contract_addresses

Obtén direcciones de contratos inteligentes para Orderly en cadenas específicas.

Parámetros:

• chain (string, obligatorio): Nombre de la cadena (ej., 'arbitrum', 'optimism', 'base')

• contractType (string, opcional): Tipo de contrato o 'all' (predeterminado: 'all')

• network (string, opcional): 'mainnet' o 'testnet' (predeterminado: 'mainnet')

Cadenas compatibles:

• EVM: ethereum, arbitrum, optimism, base, mantle, solana

• Orderly L2: orderlyL2

4. explain_workflow

Obtén una explicación paso a paso de los flujos de trabajo de desarrollo comunes.

Parámetros:

• workflow (string, obligatorio): Nombre del flujo de trabajo

Flujos de trabajo disponibles:

• wallet-connection: Conectar billetera y crear clave de Orderly

• place-first-order: Flujo completo para realizar la primera operación

• deposit-funds: Depositar USDC/tokens en Orderly

• set-tp-sl: Establecer Take Profit y Stop Loss

• subaccount-management: Crear y gestionar subcuentas

5. get_api_info

Obtén información sobre la API REST de Orderly o los streams de WebSocket.

Parámetros:

• type (string, obligatorio): 'rest', 'websocket', o 'auth'

• endpoint (string, opcional): Endpoint específico o nombre del stream

6. get_indexer_api_info

Obtén información sobre la API del Indexador de Orderly para métricas de trading, eventos de cuenta, estadísticas de volumen y clasificaciones.

Parámetros:

• endpoint (string, opcional): Ruta o nombre del endpoint específico (ej., '/events_v2', 'daily_volume', 'ranking/positions')

• category (string, opcional): Filtrar por categoría (ej., 'trading_metrics', 'events', 'ranking')

Categorías disponibles:

• Métricas de trading: Volumen diario, comisiones, datos de trading perp (/daily_volume, /daily_trading_fee, /daily_orderly_perp)

• Eventos: Eventos de cuenta con paginación (/events_v2) - operaciones, liquidaciones, transacciones

• Estadísticas de volumen: Estadísticas de volumen de cuenta y broker (/get_account_volume_statistic, /get_broker_volume_statistic)

• Clasificaciones: Posiciones, PnL, volumen de trading, depósitos/retiros (/ranking/positions, /ranking/realized_pnl, /ranking/trading_volume, /ranking/deposit, /ranking/withdraw)

Ejemplo:

# 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

Obtén orientación sobre la creación de componentes de interfaz de usuario de React utilizando el SDK de Orderly.

Parámetros:

• component (string, obligatorio): Tipo de componente

• complexity (string, opcional): 'minimal', 'standard', o 'advanced' (predeterminado: 'standard')

Componentes disponibles:

• order-entry: Formulario de colocación de órdenes

• orderbook: Visualización de profundidad de mercado

• positions: Tabla de gestión de posiciones

• wallet-connector: Interfaz de conexión de billetera

8. get_orderly_one_api_info

Obtén información sobre la API de Orderly One para la creación, graduación y gestión de DEX.

Parámetros:

• endpoint (string, opcional): Ruta o nombre del endpoint específico (ej., '/dex', 'verify-tx', '/theme/modify')

• category (string, opcional): Filtrar por categoría (ej., 'auth', 'dex', 'graduation', 'theme', 'stats', 'leaderboard', 'admin')

Categorías disponibles:

• auth: Autenticación basada en firma de billetera (nonce, verify, validate)

• dex: Gestión de DEX - crear, actualizar, eliminar, desplegar y gestionar exchanges

• graduation: Sistema de graduación - actualizar de demo a broker completo con división de comisiones

• theme: Generación de temas impulsada por IA y personalización CSS

• stats: Estadísticas y análisis de toda la plataforma

• leaderboard: Clasificaciones de DEX, métricas de rendimiento y tablas de clasificación

• admin: Operaciones administrativas para la gestión de la plataforma

Ejemplo:

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

Recursos disponibles

Accede a documentación completa a través de URIs de recursos. Todos los recursos admiten búsqueda difusa con paginación:

Parámetros de consulta:

• search (obligatorio) - Consulta de búsqueda difusa

• page (opcional) - Número de página (predeterminado: 1)

• limit (opcional) - Resultados por página, máximo 10 (predeterminado: 10)

Recursos:

• orderly://overview - Arquitectura del protocolo de alto nivel (no requiere búsqueda)

• orderly://sdk/hooks?search=orderEntry - Buscar hooks del SDK por nombre, descripción o categoría

• orderly://sdk/components?search=Checkbox - Buscar componentes por nombre o descripción

• orderly://contracts?search=arbitrum - Buscar contratos por cadena o nombre

• orderly://workflows?search=wallet - Buscar flujos de trabajo por nombre o pasos

• orderly://api/rest?search=position - Buscar endpoints de la API REST

• orderly://api/websocket?search=orderbook - Buscar streams de WebSocket

• orderly://api/indexer?search=events - Buscar endpoints de la API del Indexador

Ejemplo:

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

Ejemplo de uso

Búsqueda en la documentación

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

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

Obtención de un patrón de SDK

User: "Show me how to use useOrderEntry"

AI uses get_sdk_pattern with pattern "useOrderEntry"
→ Returns hook documentation with usage example

Búsqueda de contratos

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

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

Explicación de flujos de trabajo

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

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

Guía de construcción de componentes

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

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

Fuentes de datos

Este servidor MCP incluye datos integrados de:

1. Documentación de Orderly: Arquitectura, conceptos y guías

2. Patrones de SDK: Ejemplos de hooks v2 y patrones de @orderly.network/hooks

3. Ejemplos de DEX: Componentes funcionales completos del repositorio example-dex

4. Direcciones de contratos: Todos los contratos desplegados en las cadenas compatibles

5. Especificaciones de API: Endpoints REST y WebSocket

6. API de Indexador: Métricas de trading, eventos de cuenta, estadísticas de volumen y clasificaciones

7. API de Orderly One: Documentación de la API de creación, graduación y gestión de DEX

8. Guías de flujo de trabajo: Explicaciones de tareas comunes de desarrollo

Estructura del proyecto

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

Actualización de datos

Todos los archivos de datos en src/data/ se generan automáticamente mediante scripts en la carpeta scripts/. No edites los archivos JSON manualmente - se sobrescribirán cuando se ejecuten los scripts de regeneración.

Requisitos previos

1. Clave de API de NEAR AI en el archivo .env: NEAR_AI_API_KEY=tu_clave

2. Obtén la clave de API en: https://cloud.near.ai/api-keys

Regeneración completa (Recomendado)

Genera todo desde cero:

# 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

Actualizar solo la documentación

Si solo quieres actualizar desde los documentos oficiales sin datos de 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

Archivos de datos