3535
3636## 快速开始
3737
38- ### 方式 1: 无需安装直接试用 (uvx)
38+ ### 方式 1:使用 uvx(推荐)🚀
39+
40+ ** 最简单的方式** - 无需安装,直接运行:
3941
4042``` bash
41- # 设置配置
42- export HYPERLIQUID_PRIVATE_KEY=" 0x..."
43- export HYPERLIQUID_TESTNET=" true" # 先用测试网!
43+ # 查看帮助
44+ uvx --python 3.13 --from hyperliquid-mcp-python hyperliquid-mcp --help
4445
45- # 直接从 GitHub 运行
46- uvx --from git+https://github.com/jamiesun/hyperliquid-mcp.git hyperliquid-mcp
46+ # 启动 HTTP 服务器
47+ uvx --python 3.13 --from hyperliquid-mcp-python hyperliquid-mcp start
48+
49+ # 启动 stdio 服务器(用于 MCP 客户端)
50+ uvx --python 3.13 --from hyperliquid-mcp-python hyperliquid-mcp stdio
4751```
4852
49- ### 方式 2: 本地开发
53+ > ** 为什么要指定 ` --python 3.13 ` ?**
54+ > 依赖包 ` ckzg ` 目前只提供到 Python 3.13 的预编译包,Python 3.14 还不支持。指定版本可以避免编译错误。
5055
51- ``` bash
52- # 安装 uv(如需要)
53- curl -LsSf https://astral.sh/uv/install.sh | sh
56+ ### 方式 2:本地开发安装
5457
55- # 克隆并设置
56- git clone < repository-url>
58+ ``` bash
59+ # 克隆仓库
60+ git clone https://github.com/jamiesun/hyperliquid-mcp.git
5761cd hyperliquid-mcp
62+
63+ # 安装依赖(uv 会自动处理编译)
5864uv sync
5965
60- # 配置(复制并编辑 .env.example 为 .env)
61- cp .env.example .env
66+ # 配置
67+ cp .env.example .env # 然后编辑 .env 文件
68+ # 或设置环境变量
69+ export HYPERLIQUID_PRIVATE_KEY=" 0x..."
70+ export HYPERLIQUID_TESTNET=" true" # 强烈建议先用测试网!
6271
6372# 运行
64- uv run hyperliquid-mcp
73+ uv run hyperliquid-mcp # HTTP 模式(默认 127.0.0.1:8080)
74+ uv run hyperliquid-mcp stdio # stdio 模式(用于 MCP 客户端)
75+ uv run hyperliquid-mcp --help # 查看帮助
6576```
6677
67- ### 方式 3: 全局安装
78+ ### 方式 3:pip 安装(需要 Python 3.10-3.13)
6879
6980``` bash
70- uv pip install git+https://github.com/jamiesun/hyperliquid-mcp.git
71- hyperliquid-mcp
81+ # 使用 pip(需要 Python 3.10-3.13)
82+ pip install hyperliquid-mcp-python
83+
84+ # 运行
85+ hyperliquid-mcp --help
7286```
7387
88+ > ** 注意** : 包要求 Python 3.10-3.13。Python 3.14 还不支持。
89+
7490## 配置
7591
7692创建 ` .env ` 文件或设置环境变量:
@@ -85,28 +101,51 @@ HYPERLIQUID_ACCOUNT_ADDRESS= # 可选,自动从私钥派生
85101## 使用方法
86102
87103``` bash
88- # 本地开发
89- uv run hyperliquid-mcp # HTTP 服务器(默认)
90- uv run hyperliquid-mcp stdio # stdio 模式(用于 MCP 客户端)
91- uv run hyperliquid-mcp --help # 显示帮助
104+ # 已安装的包(推荐)
105+ hyperliquid-mcp # HTTP 服务器(默认)
106+ hyperliquid-mcp stdio # stdio 模式(用于 MCP 客户端)
107+ hyperliquid-mcp --help # 显示帮助
92108
93- # 远程执行(无需安装)
94- uvx --from git+https://github.com/jamiesun/hyperliquid-mcp.git hyperliquid-mcp
95-
96- # 全局安装后
97- hyperliquid-mcp
109+ # 本地开发
110+ uv run hyperliquid-mcp
111+ uv run hyperliquid-mcp stdio
98112```
99113
100114### MCP 客户端集成 (Claude Desktop)
101115
102116添加到 ` ~/Library/Application Support/Claude/claude_desktop_config.json ` :
103117
118+ ** 推荐配置(本地安装)**
119+
104120``` json
105121{
106122 "mcpServers" : {
107123 "hyperliquid" : {
108124 "command" : " uv" ,
109- "args" : [" --directory" , " /path/to/hyperliquid-mcp" , " run" , " hyperliquid-mcp" , " stdio" ],
125+ "args" : [
126+ " --directory" ,
127+ " /path/to/hyperliquid-mcp" ,
128+ " run" ,
129+ " hyperliquid-mcp" ,
130+ " stdio"
131+ ],
132+ "env" : {
133+ "HYPERLIQUID_PRIVATE_KEY" : " 0x..." ,
134+ "HYPERLIQUID_TESTNET" : " true"
135+ }
136+ }
137+ }
138+ }
139+ ```
140+
141+ ** 如果全局安装成功**
142+
143+ ``` json
144+ {
145+ "mcpServers" : {
146+ "hyperliquid" : {
147+ "command" : " hyperliquid-mcp" ,
148+ "args" : [" stdio" ],
110149 "env" : {
111150 "HYPERLIQUID_PRIVATE_KEY" : " 0x..." ,
112151 "HYPERLIQUID_TESTNET" : " true"
0 commit comments