使用说明

项目简介

Deriv API Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 提供访问 Deriv API 的能力。通过此服务器,LLM 可以调用预设的工具来获取 Deriv 交易平台的相关数据,例如当前活跃的交易品种列表和账户余额。

主要功能点

  • 获取活跃交易品种列表: 提供 'get_active_symbols' 工具,允许 LLM 获取 Deriv 平台当前活跃的交易品种信息。
  • 获取账户余额: 提供 'get_account_balance' 工具,允许 LLM 查询 Deriv 交易账户的当前余额。

安装步骤

本地安装

  1. 确保已安装 'uv' 包管理器。如果没有安装,请根据仓库 README 中的指引进行安装:
    curl -LsSf https://astral.sh/uv/install.sh | sh
  2. 克隆或下载此 GitHub 仓库到本地。
  3. 导航到项目根目录 'mcp-deriv-api-server'。

Docker 安装

  1. 确保已安装 Docker。
  2. 克隆或下载此 GitHub 仓库到本地。
  3. 导航到项目根目录 'mcp-deriv-api-server'。
  4. 构建 Docker 镜像:
    docker build -t deriv-api-mcp .

服务器配置

要将此 MCP 服务器与 MCP 客户端(如 Claude Desktop)配合使用,您需要在客户端的 MCP 服务器配置中添加以下信息。以下分别是本地安装和 Docker 安装的配置示例。

本地安装配置

将以下 JSON 配置添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 中。请根据您的操作系统查找对应的配置文件路径。

{
  "mcpServers": {
    "deriv-api-mcp": {  // 服务器名称,可以自定义
      "command": "uv",  // 启动服务器的命令,这里使用 uv 包管理器
      "args": [         // 传递给命令的参数列表
        "--directory",  // 指定工作目录
        "/Users/raju/Sites/deriv/mcp-deriv-api-server", // 请替换为您的项目本地路径
        "run",          // 使用 uv 运行 Python 脚本
        "server.py"     // 要运行的服务器脚本
      ]
    }
  }
}

Docker 安装配置

将以下 JSON 配置添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 中。请根据您的操作系统查找对应的配置文件路径。

{
  "mcpServers": {
    "deriv-api-mcp": {  // 服务器名称,可以自定义
      "command": "docker", // 启动服务器的命令,这里使用 docker
      "args": [         // 传递给命令的参数列表
        "run",          // 运行 docker 容器
        "--rm",         // 容器退出后自动删除
        "-i",           // 保持 STDIN 打开,即使未连接
        "deriv-api-mcp" // Docker 镜像名称,与构建时指定的名称一致
      ]
    }
  }
}

环境变量配置

在项目根目录下创建 '.env' 文件,并填入您的 Deriv API 密钥:

DERIV_API_TOKEN=your_api_key_here  # 替换为您的 Deriv API 密钥

基本使用方法

  1. 按照上述步骤安装并配置 MCP 服务器。
  2. 启动 MCP 客户端(如 Claude Desktop),并确保已加载 MCP 服务器配置。
  3. 在 MCP 客户端中,您可以指示 LLM 使用 'get_active_symbols' 或 'get_account_balance' 工具。例如,您可以向 LLM 提问:
    • "请帮我获取当前活跃的交易品种列表" (LLM 可能会调用 'get_active_symbols' 工具)
    • "我的 Deriv 账户余额是多少?" (LLM 可能会调用 'get_account_balance' 工具)
  4. LLM 将通过 MCP 协议与 Deriv API Server 通信,执行相应的工具并返回结果。

请注意: 使用 Deriv API 需要有效的 API Token,并请遵守 Deriv API 的速率限制和使用条款。 详细信息请参考 Deriv API 文档

信息

分类

商业系统