Alexanimal Tradovate MCP Server

🚀 Tradovate MCP Server

A Model Context Protocol (MCP) server for interacting with the Tradovate API. This server provides tools for managing contracts, positions, orders, and accounts.

🚀 Quick Start

This is a Model Context Protocol (MCP) server designed to interact with the Tradovate API. It offers a suite of tools for managing contracts, positions, orders, and accounts.

✨ Features

• Authentication for the Tradovate API.
• Real - time data retrieval with caching capabilities.
• Tools for contract details, position management, order placement, and more.
• Provision of mock data as a backup when the API is unavailable.

📦 Installation

1. Clone the repository.
2. Install the dependencies:

npm install

3. Create a .env file and add your Tradovate credentials:

TRADOVATE_API_ENVIRONMENT=demo
TRADOVATE_USERNAME=your_username
TRADOVATE_PASSWORD=your_password
TRADOVATE_APP_ID=Sample App
TRADOVATE_APP_VERSION=1.0
TRADOVATE_CID=your_cid
TRADOVATE_SEC=your_sec

💻 Usage Examples

Basic Usage

Start the server:

npm start

Advanced Usage

Use the MCP Inspector:

npm run inspector

📚 Documentation

Project Structure

• src/index.ts - The main entry file of the server.
• src/auth.ts - Authentication functionality.
• src/data.ts - Data retrieval and caching.
• src/tools.ts - MCP tool handler.
• src/types.ts - TypeScript type definitions.
• tests/ - Test files.

Build Process

npm run build

Testing

Run tests:

npm test

Run tests with coverage:

npm run test:coverage

Generate a coverage badge:

npm run coverage:badge

Available Tools

The server provides the following tools:

1. get_contract_details - Get detailed information about a specific contract (by symbol).
2. list_positions - List positions in the account.
3. place_order - Place a new order.
4. modify_order - Modify an existing order.
5. cancel_order - Cancel an existing order.
6. liquidate_position - Liquidate a position.
7. get_account_summary - Get account summary information.
8. get_market_data - Get market data (quotes, depth charts).

API Endpoints

The endpoints through which the server interacts with the Tradovate API include:

Authentication

• /auth/accessToken - Get an access token.
• /auth/refreshToken - Refresh an access token.

Contract - related

• /contracts - Get information about all contracts.
• /contracts/{id} - Get detailed information about a specific contract.

Position Management

• /positions - List all positions.
• /positions/{id} - Get information about a specific position.

Order Processing

• /orders - Place a new order or list all orders.
• /orders/{id} - Get or cancel a specific order.
• /orderBook - Get order book information.

Account - related

• /accounts - List information about all accounts.
• /balances - Query the fund balance.
• /transfers - Handle fund transfers.

Market Data

• /quotes - Get real - time quote data.
• /candles - Get historical candlestick data.
• /marketDEPTH - View market depth.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.