Paradex

🚀 MCP Paradex Server

The MCP Paradex Server is an implementation of the Model Context Protocol (MCP) server for the Paradex trading platform. It provides interfaces and tools for interacting with the Paradex platform.

🚀 Quick Start

The MCP Paradex Server offers a set of interfaces and tools for seamless interaction with the Paradex platform. Before you start, ensure you meet the prerequisites and follow the installation and configuration steps.

✨ Features

System Tools

• paradex-system-config: Retrieve the global configuration of the Paradex system.
• paradex-system-time: Get the Paradex server time.
• paradex-system-state: Obtain the current system state.

Market Tools

• paradex-market-names: Fetch the list of available markets.
• paradex-market-details: Get detailed information about a specific market.
• paradex-market-summaries: Retrieve summary data for all or specific markets.
• paradex-funding-data: Obtain the funding rate data of the market.
• paradex-orderbook: Get the current order book.
• paradex-klines: Fetch historical K-line data.
• paradex-trades: Retrieve recent trade records.
• paradex-bbo: Get the best bid and ask prices.

Account Tools

• paradex-account-summary: Obtain an overview of the account information.
• paradex-account-positions: Get the current positions.
• paradex-account-fills: Retrieve the trade execution records.
• paradex-account-funding-payments: Obtain the funding fee payment records.
• paradex-account-transactions: Get the transaction history.

Order Tools

• paradex-account-open-orders: Fetch all open orders.
• paradex-create-order: Create a new order.
• paradex-cancel-order: Cancel a specified order.
• paradex-cancel-order-by-client-id: Cancel an order by the client ID.
• paradex-cancel-all-orders: Cancel all open orders.
• paradex-get-order-status: Get the order status.
• paradex-get-order-by-client-id: Get the order status by the client ID.
• paradex-get-orders-history: Retrieve the historical order records.

Vault Tools

• paradex-vault-list: List all available vaults.
• paradex-vault-details: Get detailed information about a specific vault.
• paradex-vaults-config: Obtain the vault configuration options.
• paradex-vault-balance: Get the vault balance.
• paradex-vault-summary: Obtain an overview of the vault status.
• paradex-vault-transfers: Retrieve the vault transfer records.
• paradex-vault-positions: Get the current positions in the vault.
• paradex-vault: Get the vault transaction history.

📦 Installation

Prerequisites

• Operating System: Supports Linux, macOS, or Windows.
• Python Version: Requires Python 3.6 or higher.

Steps

1. Clone the Repository

Use the following command to clone the project repository:

git clone https://github.com/sv/mcp-paradex-server.git

2. Create a Virtual Environment (Optional but Recommended)

Navigate to the project directory and create a virtual environment:

cd mcp-paradex-server
python -m venv venv
source venv/bin/activate  # On Linux/macOS
venv\Scripts\activate      # On Windows

3. Install Dependencies

Install the project dependencies:

pip install -r requirements.txt

🛠️ Configuration

Environment Variable Configuration

Edit the .env file and add the following content:

API_KEY=your_api_key
API_SECRET=your_api_secret
PARADEX_URL=https://api.paradex.com

Example Configuration File

The .env.example file provides a configuration example:

DEBUG=True
PORT=8000
DATABASE_URL=sqlite:///db.sqlite3

💻 Usage Examples

Starting the Server

Run the following command to start the MCP Paradex Server:

python run.py

Stopping the Server

Use Ctrl+C or write a script to gracefully shut down the service.

📚 Documentation

Development Guide

Creating New Features

1. Create new routes or services in the app/ directory.
2. Configure project parameters using config.py.

Testing

Run unit tests:

pytest tests/

Project Structure

• app/: The main logic of the application.
• config.py: Configuration file.
• requirements.txt: List of dependencies.
• run.py: Startup script.

Contribution Guide

1. Ensure all tests pass before submitting code.
2. The submitted code should follow the project's coding standards.
3. Add documentation and tests for new features.

📄 License

This project is licensed under the MIT License.