Skip to main content
Glama

Freqtrade-MCP

An MCP server that integrates with the Freqtrade cryptocurrency trading bot via its REST API, enabling seamless AI agent interaction for automated trading operation.

For more crypto-related MCP servers, see the Kukapay MCP servers.

GitHub License Python Version Status

Installation

Prerequisites

  • Python 3.13+: Ensure Python is installed on your system.

  • Freqtrade: A running Freqtrade instance with the REST API enabled (see Freqtrade Docs).

  • Git: For cloning the repository.

Steps

  1. Clone the Repository:

    git clone https://github.com/kukapay/freqtrade-mcp.git
    cd freqtrade-mcp
  2. Install Dependencies: Using pip:

    pip install freqtrade-client mcp[cli]

    Or with uv (optional):

    uv add freqtrade-client "mcp[cli]"
  3. Client Configuration:

    "mcpServers": { 
      "freqtrade-mcp": { 
        "command": "uv", 
        "args": [ 
          "--directory", "/your/path/to/freqtrade-mcp", 
          "run", 
          "__main__.py" 
        ], 
        "env": { 
           "FREQTRADE_API_URL": "http://127.0.0.1:8080",
           "FREQTRADE_USERNAME": "your_username",
           "FREQTRADE_PASSWORD": "your_password"
        } 
      } 
    }
  4. Freqtrade Configuration:

    Enable the rest API by adding the api_server section to your configuration and setting api_server.enabled to true.

    Sample configuration:

        "api_server": {
        "enabled": true,
        "listen_ip_address": "127.0.0.1",
        "listen_port": 8080,
        "verbosity": "error",
        "enable_openapi": false,
        "jwt_secret_key": "somethingrandom",
        "CORS_origins": [],
        "username": "Freqtrader",
        "password": "SuperSecret1!",
        "ws_token": "sercet_Ws_t0ken"
    },

    Check the document here.

Related MCP server: Dragonglass TradingView MCP

Usage

Available Tools

The server exposes the following Freqtrade API endpoints as MCP tools:

Tool

Description

Parameters

fetch_market_data

Fetch OHLCV data for a pair

pair: str, timeframe: str

fetch_bot_status

Get open trade status

None

fetch_profit

Get profit summary

None

fetch_balance

Get account balance

None

fetch_performance

Get performance metrics

None

fetch_whitelist

Get whitelist of pairs

None

fetch_blacklist

Get blacklist of pairs

None

fetch_trades

Get trade history

None

fetch_config

Get bot configuration

None

fetch_locks

Get trade locks

None

place_trade

Place a buy/sell trade

pair: str, side: str, stake_amount: float

start_bot

Start the bot

None

stop_bot

Stop the bot

None

reload_config

Reload bot configuration

None

add_blacklist

Add pair to blacklist

pair: str

delete_blacklist

Remove pair from blacklist

pair: str

delete_lock

Delete a trade lock

lock_id: int

run_backtest

Start backtest via REST API

strategy: str, enable_protections: bool, optional timerange, timeframe

fetch_backtest_status

Get current backtest status/result

None

fetch_backtest_history

List backtest history

optional filename: str

abort_backtest

Abort currently running backtest

None

reset_backtest

Reset backtest state/result

None

Example Prompts

  1. Fetch Market Data:

    • "Show me the hourly price data for BTC/USDT."

    • "What’s the 5-minute chart for ETH/BTC like?"

    • "Give me the latest candlestick data for XRP/USDT over the past hour."

  2. Fetch Bot Status:

    • "What’s the current status of my open trades?"

    • "Are there any active trades right now?"

    • "Tell me about the bot’s trading activity at the moment."

  3. Fetch Profit:

    • "How much profit have I made so far?"

    • "What’s the total profit summary for the bot?"

    • "Can you show me my trading gains?"

  4. Fetch Balance:

    • "What’s my account balance?"

    • "How much money do I have in the trading account?"

    • "Tell me the current balance of my Freqtrade wallet."

  5. Fetch Performance:

    • "How well has the bot been performing?"

    • "What are the performance metrics for my trades?"

    • "Show me the trading stats."

  6. Fetch Whitelist:

    • "Which pairs are on the whitelist?"

    • "What trading pairs is the bot allowed to use?"

    • "List the whitelisted pairs for me."

  7. Fetch Blacklist:

    • "Which pairs are blacklisted?"

    • "What trading pairs are blocked right now?"

    • "Tell me about the blacklist."

  8. Fetch Trades:

    • "What’s the history of my closed trades?"

    • "Show me all the trades the bot has completed."

    • "Can you list my past trades?"

  9. Fetch Config:

    • "What’s the current bot configuration?"

    • "Show me the settings the bot is using."

    • "Tell me about the Freqtrade config."

  10. Fetch Locks:

    • "Are there any trade locks active?"

    • "What locks are currently in place?"

    • "Show me the list of trading locks."

  11. Place Trade:

    • "Buy 0.01 BTC/USDT right now."

    • "Sell 0.05 ETH/USDT immediately."

    • "Place a buy order for 0.1 XRP/USDT."

  12. Start Bot:

    • "Start the trading bot."

    • "Turn on the Freqtrade bot."

    • "Get the bot running now."

  13. Stop Bot:

    • "Stop the trading bot."

    • "Shut down the Freqtrade bot."

    • "Pause the bot’s trading."

  14. Reload Config:

    • "Reload the bot’s configuration."

    • "Update the bot settings."

    • "Refresh the Freqtrade config."

  15. Add Blacklist:

    • "Blacklist ETH/USDT."

    • "Add BTC/ETH to the blacklist."

    • "Block trading for XRP/USDT."

  16. Delete Blacklist:

    • "Remove ETH/USDT from the blacklist."

    • "Unblock BTC/ETH for trading."

    • "Take XRP/USDT off the blacklist."

  17. Delete Lock:

    • "Delete the trade lock with ID 123."

    • "Remove lock number 45."

    • "Unlock the trade with ID 7."

License

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

Available Tools

22 tools
abort_backtestB

Abort currently running backtest task.

Inputs: no named parameters.

add_blacklistC

Add a pair to the blacklist.

Parameters: pair (str): Trading pair to blacklist (e.g., "ETH/USDT"). ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with updated blacklist, or error if failed.

Inputs: pair (required).

delete_blacklistB

Remove a pair from the blacklist.

Parameters: pair (str): Trading pair to remove from blacklist (e.g., "ETH/USDT"). ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with updated blacklist, or error if failed.

Inputs: pair (required).

delete_lockB

Delete a specific trade lock by ID.

Parameters: lock_id (int): ID of the trade lock to delete. ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with updated locks, or error if failed.

Inputs: lock_id (required).

fetch_backtest_historyB

Get backtest result history; optionally filter by filename.

Inputs: filename.

fetch_backtest_statusA

Get current backtest execution status and latest result payload.

Inputs: no named parameters.

fetch_balanceB

Fetch the account balance.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with account balance, or None if failed.

Inputs: no named parameters.

fetch_blacklistB

Get the current blacklist of trading pairs.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with blacklist data, or None if failed.

Inputs: no named parameters.

fetch_bot_statusB

Retrieve the current status of open trades.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with open trade status, or None if failed.

Inputs: no named parameters.

fetch_configB

Retrieve the current bot configuration.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with configuration data, or None if failed.

Inputs: no named parameters.

fetch_locksB

Get the current trade locks.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with trade locks data, or None if failed.

Inputs: no named parameters.

fetch_market_dataB

Fetch OHLCV data for a specified trading pair and timeframe.

Parameters: pair (str): Trading pair (e.g., "BTC/USDT"). timeframe (str): Timeframe for the data (e.g., "1h", "5m"). ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response containing OHLCV data, or None if failed.

Inputs: pair (required), timeframe (required).

fetch_performanceC

Retrieve trading performance metrics.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with performance metrics, or None if failed.

Inputs: no named parameters.

fetch_profitB

Get profit summary for the trading bot.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with profit summary, or None if failed.

Inputs: no named parameters.

fetch_tradesB

Fetch the history of closed trades.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with trade history, or None if failed.

Inputs: no named parameters.

fetch_whitelistB

Get the current whitelist of trading pairs.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with whitelist data, or None if failed.

Inputs: no named parameters.

place_tradeC

Place a trade (buy or sell) with the specified pair and amount.

Parameters: pair (str): Trading pair (e.g., "BTC/USDT"). side (str): Trade direction, either "buy" or "sell". stake_amount (float): Amount to trade in the stake currency. ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response with trade result, or error message if failed.

Inputs: pair (required), side (required), stake_amount (required).

reload_configC

Reload the bot configuration.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response or success message, or error if failed.

Inputs: no named parameters.

reset_backtestB

Reset backtest state/result on the API server.

Inputs: no named parameters.

run_backtestC

Start a REST backtest job.

Required fields follow freqtrade REST requirements: strategy and enable_protections.

Inputs: strategy (required), enable_protections (required), timerange, timeframe, +4 more.

start_botC

Start the Freqtrade bot.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response or success message, or error if failed.

Inputs: no named parameters.

stop_botC

Stop the Freqtrade bot.

Parameters: ctx (Context): MCP context object for logging and client access.

Returns: str: Stringified JSON response or success message, or error if failed.

Inputs: no named parameters.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.3/5.0

    Scored across 22 tools

    Disambiguation4/5

    Most tools have distinct purposes targeting specific resources like blacklist, backtest, or bot operations, with clear boundaries. However, some fetch tools like fetch_bot_status and fetch_trades might be slightly overlapping in providing trade-related information, but descriptions help differentiate them.

    Naming Consistency5/5

    Tools follow a highly consistent verb_noun pattern throughout, such as fetch_balance, add_blacklist, and run_backtest. All names use snake_case with clear verbs, making them predictable and easy to understand.

    Tool Count3/5

    With 22 tools, the count is borderline high for a trading bot server, potentially feeling heavy. While it covers many aspects, some tools might be consolidated or omitted without losing core functionality, indicating a slight over-scoping.

    Completeness5/5

    The tool set provides comprehensive coverage for the Freqtrade domain, including CRUD operations for blacklist/locks, bot lifecycle management, data fetching, and backtesting. No obvious gaps are present; agents can handle full workflows from configuration to trading and analysis.

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      D
      maintenance
      MCP server that connects AI agents to Freqtrade crypto trading bot via REST API. It provides 15 tools for account stats, trade management, market data, pair lists, and bot lifecycle control.
      19
      44 npm
      2
      MIT
    • F
      license
      Not graded
      quality
      B
      maintenance
      Enables AI co-pilots to interact with TradingView charts, manage alerts via REST API, automate morning briefs with custom trading rules, and perform real-time market analysis.
      -
    • A
      license
      Not graded
      quality
      C
      maintenance
      An MCP server for cryptocurrency trading via Freqtrade, enabling trade management, balance checks, strategy configuration, backtesting, and bot lifecycle control from any MCP-compatible AI agent.
      MIT
    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables AI assistants to interact directly with the Binance cryptocurrency exchange for trading, portfolio management, market analysis, and strategy automation via natural language.
      134 npm
      MIT