Xtbapiserver Wgv

🚀 XTBApiServer

This is an MCP server that exposes the XTB API using the @sharplygroup/xtb-api-js library. It allows you to interact with your XTB trading account via the Model Context Protocol.

🚀 Quick Start

✨ Features

This MCP server exposes the XTB API, enabling interaction with XTB trading accounts using the Model Context Protocol. It provides a variety of tools for account operations, calculations, market data retrieval, and more.

📦 Installation

Prerequisites

• Node.js (version 16 or higher)
• npm
• An XTB trading account

Steps

1. Clone this repository:

   git clone [repository_url]
   

2. Navigate to the project directory:

   cd xtb-mcp-server
   

3. Install dependencies:

   npm install
   

⚙️ Configuration

1. Create a .env file in the project directory and add your XTB API credentials:

   DEMO_ACCOUNT=true
   USER_ID=your_user_id
   PASSWORD=your_password
   

   ⚠️ Important Note

   Replace your_user_id and your_password with your actual XTB API credentials. Set DEMO_ACCOUNT to false if you are using a live account.

▶️ Running the Server

1. Build the TypeScript code:

   npm run build
   

2. Start the server:

   node build/index.js
   

🔗 Connecting with an MCP Client

You can connect to this server using any MCP client (e.g., MCP Inspector).

1. Install MCP Inspector globally:

   npm install -g @modelcontextprotocol/inspector
   

2. Run MCP Inspector with your server:

   npx @modelcontextprotocol/inspector node build/index.js
   

3. In the MCP Inspector UI, select "stdio" as the transport type and click "Connect".

💻 Usage Examples

Available Tools

This MCP server exposes the following tools:

Account Operations

• getCurrentUserData: Returns information about the account currency and account leverage.
• getMarginLevel: Returns various account metrics.

Calculation Operations

• getCommissionDef: Calculates commissions and exchange rates.
  • Parameters: symbol (string), volume (number)
• getMarginTrade: Returns the expected margin based on the given instrument and quantity.
  • Parameters: symbol (string), volume (number)
• getProfitCalculation: Calculates the estimated profit based on the given trading data.
  • Parameters: closePrice (number), cmd (number), openPrice (number), symbol (string), volume (number)

Market Data Operations

• getCalendar: Returns the market event calendar.
• getChartLastRequest: Returns chart information from the start date to the current time.
  • Parameters: info (any)
• getChartRangeRequest: Returns chart information for a specified time period.
  • Parameters: info (any)
• getOHLCV: Retrieves the open, high, low, and close data for a given instrument.
  • Parameters: symbol (string), start (number), end (number)

Prompts

• getSymbolInfoPrompt: Retrieves information about a specific instrument.
  • Parameters: symbol (string)