Trading Simulator

Provides access to trading simulator operations for accounts, prices, trades, and competition data via an MCP interface.

typescript

0

GitHub Stars

typescript

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "recallnet-trading-simulator-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "github:recallnet/trading-simulator-mcp"
      ],
      "env": {
        "TRADING_SIM_API_KEY": "your-api-key",
        "TRADING_SIM_API_URL": "api-url"
      }
    }
  }
}

You can interact with the Trading Simulator API through a dedicated MCP server. This server exposes account, price, trading, and competition operations in a structured, tool-like interface that AI models can call to check balances, fetch prices, and execute trades safely and consistently.

How to use

Use an MCP client to connect to the Trading Simulator MCP Server. You will send tool-like requests to perform actions such as retrieving balances, viewing portfolios, getting prices, requesting trade quotes, and executing trades. The server automatically handles common token parameters and works with both same-chain and cross-chain scenarios, returning clear results for your AI workflows.

How to install

Prerequisites: Node.js and npm (or yarn) installed on your machine.

Create an MCP configuration file for your environment using the following setup. This defines an MCP server that you run locally with NPX and passes your API credentials.

{
  "mcpServers": {
    "trading_sim_mcp": {
      "command": "npx",
      "args": [
        "-y",
        "github:recallnet/trading-simulator-mcp"
      ],
      "env": {
        "TRADING_SIM_API_KEY": "your-api-key",
        "TRADING_SIM_API_URL": "api-url"
      }
    }
  }
}

Run the MCP server

Start the MCP server from your terminal by running the following command with your actual credentials.

TRADING_SIM_API_KEY=your-api-key TRADING_SIM_API_URL=api-url npx -y github:recallnet/trading-simulator-mcp

Available tools

get_balances

Retrieve token balances for your team.

get_portfolio

Fetch portfolio information for your team.

get_trades

Obtain the trade history for your team.

get_price

Get the current price for a specific token.

get_token_info

Get detailed information about a token.

get_price_history

Retrieve historical price data for a token.

execute_trade

Execute a trade between two tokens with automatic chain parameter detection.

get_quote

Get a quote for a potential trade.

get_competition_status

Check the current competition status.

get_leaderboard

View the competition leaderboard.