orderlynetwork/orderly-mcp

本页由 AI 翻译，技术细节请以原文为准。查看原文

10 stars 2 forks 质量 81 趋势 38MIT

A Model Context Protocol (MCP) server providing documentation and SDK patterns for Orderly Network - an omnichain perpetual futures trading infrastructure.

概览

A Model Context Protocol (MCP) server providing documentation and SDK patterns for Orderly Network - an omnichain perpetual futures trading infrastructure. Install the MCP server with one command for your AI client: 1. Create the appropriate configuration file for your AI client 2. Install @orderly.network/mcp-server as a dev dependency 3. Guide you through the next steps Restart your AI client and try asking: "How do I connect to Orderly Network?" This MCP server enables AI assistants to answer questions about Orderly Network and guide developers in building React components using the Orderly SDK v2. - : Query Orderly docs for architecture, APIs, and concepts - : Get code examples for all v2 hooks (useOrderEntry, usePositionStream, etc.

README

以下为原文 README 节选，完整内容请查看原文。

Orderly Network MCP Server

A Model Context Protocol (MCP) server providing documentation and SDK patterns for Orderly Network - an omnichain perpetual futures trading infrastructure.

Quick Start

Install the MCP server with one command for your AI client:

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

Supported clients: claude, cursor, vscode, codex, opencode

Examples

# 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

This command will:

Create the appropriate configuration file for your AI client
Install @orderly.network/mcp-server as a dev dependency
Guide you through the next steps

After installation: Restart your AI client and try asking: “How do I connect to Orderly Network?”

What This Server Provides

This MCP server enables AI assistants to answer questions about Orderly Network and guide developers in building React components using the Orderly SDK v2.

Features

Documentation Search: Query Orderly docs for architecture, APIs, and concepts
SDK Patterns: Get code examples for all v2 hooks (useOrderEntry, usePositionStream, etc.)
Contract Addresses: Lookup smart contract addresses for all supported chains
Workflow Guides: Step-by-step explanations of common development tasks
Component Guides: Patterns for building trading UI components
API Reference: REST and WebSocket endpoint documentation
Indexer API: Trading metrics, account events, trades, and volume statistics

Installation

Quick Install (Recommended)

Use the CLI to automatically configure your AI client:

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

Available clients:

Client	Command	Config Location
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`

Manual Setup

If you prefer to configure manually or the automatic setup doesn’t work for your client:

Prerequisites

Node.js 18 or higher
Yarn (or npm)

Setup from Source

Clone or create the project:

cd orderly-mcp

Install dependencies:

yarn install

Build the project:

yarn build

Hosted Server

A publicly hosted instance is available at https://mcp.orderly.network.

Health check:

在 GitHub 查看完整 README

安装

npx @orderly.network/mcp-server@latest

新手？先看 mcpskill.org 教程 →

配置

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