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.

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.

Usage

Available Tools

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

Example Prompts

1. Fetch Market Data:

2. Fetch Bot Status:

3. Fetch Profit:

4. Fetch Balance:

5. Fetch Performance:

6. Fetch Whitelist:

7. Fetch Blacklist:

8. Fetch Trades:

9. Fetch Config:

10. Fetch Locks:

11. Place Trade:

12. Start Bot:

13. Stop Bot:

14. Reload Config:

15. Add Blacklist:

16. Delete Blacklist:

17. Delete Lock:

License

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