Freqtrade MCP服务器使用说明

项目简介

Freqtrade MCP服务器 (freqtrade-mcp) 是一个MCP(Model Context Protocol)服务器实现,它充当AI智能体与Freqtrade交易机器人之间的桥梁。通过该服务器,AI智能体可以使用标准化的MCP协议,安全、便捷地访问Freqtrade的功能,例如获取市场数据、查询账户信息、执行交易指令、管理交易策略等。这为利用AI进行自动化加密货币交易策略提供了强大的后端支持。

主要功能点

  • 工具 (Tools) 丰富: 提供了全面的Freqtrade API接口封装,包括:
    • 数据获取: 获取市场OHLCV数据、机器人状态、盈利信息、账户余额、交易表现、白名单/黑名单、交易历史、配置信息、交易锁仓等。
    • 交易操作: 执行买入/卖出交易、启动/停止机器人、重载配置、添加/删除黑名单、删除交易锁仓等。
  • Prompt模板 (Prompts): 预置了交易分析和策略建议的Prompt模板,方便AI智能体进行更高级的交易决策。
  • 易于部署: 基于Python开发,安装配置简单,可以通过环境变量进行灵活配置。
  • 安全可靠: 通过Freqtrade API的认证机制,保障交易操作的安全性。

安装步骤

  1. 克隆仓库: 使用Git克隆 'freqtrade-mcp' 仓库到本地。
    git clone https://github.com/kukapay/freqtrade-mcp.git
    cd freqtrade-mcp
  2. 安装依赖: 使用pip或uv安装项目依赖,包括 'freqtrade-client' 和 'mcp[cli]'。
    pip install freqtrade-client mcp[cli]
    或者使用 uv:
    uv add freqtrade-client "mcp[cli]"
  3. 配置Freqtrade: 确保你的Freqtrade交易机器人已启用REST API,并配置好API的监听地址、端口、用户名和密码等信息。具体配置方法请参考 Freqtrade REST API 文档

服务器配置 (MCP客户端配置)

以下是在MCP客户端中配置 'freqtrade-mcp' 服务器的示例 JSON 配置。你需要将此配置添加到你的MCP客户端的服务器列表中。

{
  "mcpServers": {
    "freqtrade-mcp": {
      "command": "uv",
      "args": [
        "--directory", "/your/path/to/freqtrade-mcp",  // 替换为你的 freqtrade-mcp 仓库的本地路径
        "run",
        "__main__.py"
      ],
      "env": {
        "FREQTRADE_API_URL": "http://127.0.0.1:8080", // 你的 Freqtrade REST API 地址
        "FREQTRADE_USERNAME": "your_username",      // 你的 Freqtrade REST API 用户名
        "FREQTRADE_PASSWORD": "your_password"      // 你的 Freqtrade REST API 密码
      }
    }
  }
}

配置参数说明:

  • '"freqtrade-mcp"': 服务器名称,可以自定义,用于在MCP客户端中标识该服务器。
  • '"command"': 启动服务器的命令,这里使用 'uv' (如果安装了 uv,也可以使用 'pipenv' 或 'python' 等)。
  • '"args"': 传递给启动命令的参数列表。
    • '"--directory", "/your/path/to/freqtrade-mcp"': 指定 'freqtrade-mcp' 仓库的本地路径,请替换为实际路径
    • '"run"': 使用 'uv run' 命令运行 Python 脚本。
    • '"main.py"': 指定要运行的 Python 脚本为仓库根目录下的 'main.py' 文件。
  • '"env"': 设置服务器运行时的环境变量。
    • '"FREQTRADE_API_URL"': 必填,你的 Freqtrade REST API 的完整 URL,例如 'http://127.0.0.1:8080'。
    • '"FREQTRADE_USERNAME"': 必填,访问 Freqtrade REST API 的用户名。
    • '"FREQTRADE_PASSWORD"': 必填,访问 Freqtrade REST API 的密码。

注意: 请确保将 '/your/path/to/freqtrade-mcp' 替换为你实际的 'freqtrade-mcp' 仓库路径,并配置正确的 'FREQTRADE_API_URL'、'FREQTRADE_USERNAME' 和 'FREQTRADE_PASSWORD' 环境变量,以便服务器能够成功连接到你的 Freqtrade 机器人。

基本使用方法

  1. 启动 Freqtrade MCP 服务器 (通过 MCP 客户端配置自动启动或手动运行 'main.py')。
  2. 在你的AI智能体应用中,通过MCP客户端连接到名为 '"freqtrade-mcp"' 的服务器。
  3. 使用MCP协议,调用服务器提供的工具 (Tools) 和 Prompt模板 (Prompts),与Freqtrade机器人进行交互,实现自动化交易策略。

具体可用的工具和Prompt模板请参考仓库 README.md 文档中的 "Usage" 部分。

信息

分类

商业系统