使用说明

项目简介

MAX交易所MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，旨在为LLM客户端提供访问MaiCoin MAX交易所API的标准化接口。通过注册和执行预设的工具 (Tools)，该服务器允许LLM客户端安全、便捷地查询市场数据、管理账户资产以及进行交易操作。

主要功能点

市场数据查询: 获取MAX交易所的交易市场列表、货币信息、市场行情 (tickers) 等。
账户信息: 查询现货 (spot) 或保证金 (m) 钱包的账户余额。
订单交易: 支持提交、查询和取消订单，包括市价单和限价单等多种订单类型。
工具注册与执行: 通过MCP协议将交易所API功能封装为可被LLM客户端调用的工具 (Tools)。
环境配置: 需要配置MAX交易所的API密钥和密钥，以进行身份验证和安全访问。

安装步骤

环境准备: 确保已安装Python环境。建议使用Python 3.8 或更高版本。
安装依赖: 使用pip安装项目依赖。在仓库根目录下执行：
```
pip install -e .
```

服务器配置

MCP服务器需要配置启动命令 (command) 及其参数 (args) 才能被MCP客户端调用。以下是根据仓库信息生成的JSON格式配置，请添加到MCP客户端的服务器配置中。

{
  "mcpServers": {
    "maxmcp": {
      "command": "uvx",  // 启动命令，这里假设使用uvicorn或类似的ASGI服务器运行
      "args": ["maxmcp.server:main"], // 启动参数，指向maxmcp.server模块的main函数
      "env": {
        "MAX_API_KEY": "",  //  MAX交易所API密钥，请替换为您的实际密钥
        "MAX_API_SECRET": "" // MAX交易所API密钥，请替换为您的实际密钥
      }
    }
  }
}

参数注释:

'server name': 'maxmcp'，服务器名称，客户端用于识别和调用。
'command': 'uvx'，运行命令，这里假设使用 'uvicorn' 或 'uvicorn-gunicorn-fork' (uvx 是 'uvicorn-gunicorn-fork' 的别名) 启动 ASGI 应用。您可能需要根据实际情况调整为 'uvicorn' 或其他 ASGI 服务器的命令。
'args': '["maxmcp.server:main"]'，命令参数，指定要运行的 Python 模块和函数。 'maxmcp.server' 指的是 'src/maxmcp/server.py' 文件，':main' 指的是该文件中的 'main' 函数，该函数负责启动 MCP 服务器。
'env': 环境变量配置。
- 'MAX_API_KEY': 必填，您的 MaiCoin MAX 交易所 API Key。请务必替换为空字符串 '""' 为您在MAX交易所申请的实际 API Key。
- 'MAX_API_SECRET': 必填，您的 MaiCoin MAX 交易所 API Secret。同样，请替换为空字符串 '""' 为您在MAX交易所申请的实际 API Secret。

注意:

请务必在MaiCoin MAX交易所申请API Key和API Secret，并将其配置到 'env' 的环境变量中，否则服务器将无法连接到交易所API。
'uvx' 命令假设您已经安装了 'uvicorn-gunicorn-fork' 或 'uvicorn' 等 ASGI 服务器。如果没有安装，请先安装 ASGI 服务器，例如 'pip install uvicorn-gunicorn-fork' 或 'pip install uvicorn'。
如果您的MCP客户端不支持 'uvx' 或需要不同的启动方式，请查阅您使用的MCP客户端的文档，并根据实际情况调整 'command' 和 'args' 配置。通常来说，MCP客户端需要能够执行一个命令来启动MCP服务器，并与其建立连接。

基本使用方法

启动MCP服务器: MCP客户端会根据您提供的服务器配置启动 'maxmcp' 服务器。
连接服务器: LLM客户端通过MCP协议连接到 'maxmcp' 服务器。
发现工具: 客户端可以向服务器查询已注册的工具列表，例如 'get_markets', 'get_currencies', 'get_accounts', 'submit_order', 'cancel_orders' 等。
调用工具: LLM客户端可以根据需要调用相应的工具，并传递必要的参数。例如，调用 'get_markets' 工具可以获取市场列表，调用 'submit_order' 工具可以提交交易订单。
接收响应: 服务器执行工具后，会将结果以MCP协议的响应格式返回给客户端。

请参考 Model Context Protocol (MCP) 官方文档 (请替换为实际的MCP文档链接，如果存在) 和 MaiCoin MAX 交易所 API 文档 (https://max.maicoin.com/documents/api_list/v3) 了解更多关于MCP协议和交易所API的详细信息。

关键词