hvip-mcp-server 0.4.3 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,165 +1,165 @@
1
- # hvip MCP Server
2
-
3
- > OKX 全部能力接入 AI —— 365 个 MCP 工具,覆盖 97.7% OKX REST API
4
-
5
- [![npm version](https://img.shields.io/npm/v/hvip-mcp-server)](https://www.npmjs.com/package/hvip-mcp-server)
6
- [![License](https://img.shields.io/npm/l/hvip-mcp-server)](https://github.com/okx-wallet-H/hvip-mcp/blob/master/LICENSE)
7
-
8
- 📦 [github.com/okx-wallet-H/hvip-mcp](https://github.com/okx-wallet-H/hvip-mcp) · 🐛 [提交反馈](https://github.com/okx-wallet-H/hvip-mcp/issues/new)
9
-
10
- ---
11
-
12
- ## 🚀 一行安装
13
-
14
- ```bash
15
- npx -y hvip-mcp-server
16
- ```
17
-
18
- 就这么简单。MCP 客户端(Claude Desktop / Claude Code / Cursor / VS Code)会自动接管。
19
-
20
- ---
21
-
22
- ## 配置到 AI 客户端
23
-
24
- **这不是命令行工具**——hvip-mcp 是 MCP (Model Context Protocol) 服务器,由 AI 客户端在后台自动运行。你只需要在配置文件中加一行 JSON,AI 自己会启动它。
25
-
26
- ### Claude Desktop
27
-
28
- Claude Desktop → 设置 → Developer → Edit Config:
29
-
30
- ```json
31
- {
32
- "mcpServers": {
33
- "hvip": {
34
- "command": "npx",
35
- "args": ["-y", "hvip-mcp-server"]
36
- }
37
- }
38
- }
39
- ```
40
-
41
- ### Claude Code
42
-
43
- 在项目根目录或全局 `.claude/settings.json`:
44
-
45
- ```json
46
- {
47
- "mcpServers": {
48
- "hvip": {
49
- "command": "npx",
50
- "args": ["-y", "hvip-mcp-server@latest"]
51
- }
52
- }
53
- }
54
- ```
55
-
56
- ### VS Code / Cline / 其他 MCP 客户端
57
-
58
- 在 MCP 配置中添加同样的 JSON。
59
-
60
- > **配置完需要完全退出并重启客户端**,重开后 AI 自动连接 hvip。
61
-
62
- ### 需要 API Key?
63
-
64
- 行情、技术指标、市场扫描等公开数据无需 Key。查看账户、下单交易需要 OKX API Key:
65
-
66
- ```json
67
- {
68
- "mcpServers": {
69
- "hvip": {
70
- "command": "npx",
71
- "args": ["-y", "hvip-mcp-server"],
72
- "env": {
73
- "OKX_API_KEY": "<你的 API Key>",
74
- "OKX_SECRET_KEY": "<你的 Secret Key>",
75
- "OKX_PASSPHRASE": "<你的 Passphrase>"
76
- }
77
- }
78
- }
79
- }
80
- ```
81
-
82
- > API Key 在 [OKX 官网](https://www.okx.com) → 个人中心 → API 中创建,开通「读取」权限即可查账户,「交易」权限可下单。
83
-
84
- ---
85
-
86
- ## 工作流
87
-
88
- AI 连接 hvip 后自动执行:
89
-
90
- ```
91
- 1. tools/list → 365 个工具,但只有 agent_catalog 带完整描述
92
- 2. agent_catalog → 15 个域的地图(7 公开 + 8 需 Key),按需直达
93
- 3. 用户说 "BTC 怎么样" → AI 调 okx_quick_market
94
- 4. 用户说 "买 0.1 BTC" → AI 先预检再下单
95
- ```
96
-
97
- **无需手动操作,全程 AI 自己来。**
98
-
99
- ---
100
-
101
- ## 工具覆盖
102
-
103
- | 模块 | 工具数 | 说明 |
104
- |------|--------|------|
105
- | 🔹 账户 | 40+ | 余额/持仓/配置/杠杆/估值 |
106
- | 🔹 行情 | 17 | Ticker/K线/深度/成交 |
107
- | 🔹 交易 | 27 | 下单/撤单/改单/批量/平仓 |
108
- | 🔹 公共数据 | 34 | 产品规格/资金费率/标记价 |
109
- | 🔹 资金 | 18 | 划转/提现/充值/兑换 |
110
- | 🔹 策略委托 | 6 | 止损止盈/冰山/移动止盈 |
111
- | 🔹 网格 | 13 | 现货网格/合约网格/定投 |
112
- | 🔹 跟单 | 23 | 交易员/跟单/带单 |
113
- | 🔹 信号 | 10 | 信号订阅/历史信号 |
114
- | 🔹 价差 | 16 | 跨品种/跨期价差 |
115
- | 🔹 RFQ | 12 | 大宗询价/报价/成交 |
116
- | 🔹 金融 | 27 | 赚币/质押/借贷 |
117
- | 🔹 预测市场 | 36 | 事件合约/预测交易 |
118
- | 🔹 技术指标 | 2 | RSI/MACD/布林带等 17 种 |
119
- | 🔹 聪明钱 | 3 | 交易员排行榜/市场情绪 |
120
- | 🔹 WebSocket | 5 | 55 频道实时推送 |
121
- | 🔹 代码图谱 | 2 | 函数调用链/符号搜索 |
122
- | 🔹 系统工具 | 19 | 导航/偏好/反馈/Agent 协作 |
123
-
124
- **365 个 MCP 工具 · 覆盖 97.7% OKX REST API**
125
-
126
- ---
127
-
128
- ## 本地开发
129
-
130
- ```bash
131
- git clone https://github.com/okx-wallet-H/hvip-mcp.git
132
- cd hvip-mcp
133
- npm install
134
- npm run build
135
- npm start
136
- ```
137
-
138
- ---
139
-
140
- ## 架构
141
-
142
- ```
143
- 原子层 (350 工具) → [L:READ] 权限标记 → AI Agent 按需调用
144
-
145
- Skill 组合层 (13 个) → 串联多工具,一次完成复杂任务
146
-
147
- agent_catalog → 15 域地图 → 按意图路由 → 直达目标工具
148
- ```
149
-
150
- ---
151
-
152
- ## 贡献
153
-
154
- 1. 阅读 [`CLAUDE.md`](./CLAUDE.md) 了解项目规范
155
- 2. 阅读 [`CONTRIBUTING.md`](./CONTRIBUTING.md) 了解提交流程
156
- 3. Fork → 创建分支 → 开发 → `npm run build` → 提 PR
157
-
158
- ---
159
-
160
- ## 文档
161
-
162
- - [`CLAUDE.md`](./CLAUDE.md) — AI Agent 项目指南
163
- - [`CONTRIBUTING.md`](./CONTRIBUTING.md) — 贡献流程
164
- - [`docs/OKX-MCP-API对接标准-v0.2.49.md`](./docs/OKX-MCP-API对接标准-v0.2.49.md) — API 对接规范
165
- - [`docs/OKX-MCP-防幻觉对接SOP-v1.0.md`](./docs/OKX-MCP-防幻觉对接SOP-v1.0.md) — 防幻觉 SOP
1
+ # hvip MCP Server
2
+
3
+ > OKX 全部能力接入 AI —— 365 个 MCP 工具,覆盖 97.7% OKX REST API
4
+
5
+ [![npm version](https://img.shields.io/npm/v/hvip-mcp-server)](https://www.npmjs.com/package/hvip-mcp-server)
6
+ [![License](https://img.shields.io/npm/l/hvip-mcp-server)](https://github.com/okx-wallet-H/hvip-mcp/blob/master/LICENSE)
7
+
8
+ 📦 [github.com/okx-wallet-H/hvip-mcp](https://github.com/okx-wallet-H/hvip-mcp) · 🐛 [提交反馈](https://github.com/okx-wallet-H/hvip-mcp/issues/new)
9
+
10
+ ---
11
+
12
+ ## 🚀 一行安装
13
+
14
+ ```bash
15
+ npx -y hvip-mcp-server
16
+ ```
17
+
18
+ 就这么简单。MCP 客户端(Claude Desktop / Claude Code / Cursor / VS Code)会自动接管。
19
+
20
+ ---
21
+
22
+ ## 配置到 AI 客户端
23
+
24
+ **这不是命令行工具**——hvip-mcp 是 MCP (Model Context Protocol) 服务器,由 AI 客户端在后台自动运行。你只需要在配置文件中加一行 JSON,AI 自己会启动它。
25
+
26
+ ### Claude Desktop
27
+
28
+ Claude Desktop → 设置 → Developer → Edit Config:
29
+
30
+ ```json
31
+ {
32
+ "mcpServers": {
33
+ "hvip": {
34
+ "command": "npx",
35
+ "args": ["-y", "hvip-mcp-server"]
36
+ }
37
+ }
38
+ }
39
+ ```
40
+
41
+ ### Claude Code
42
+
43
+ 在项目根目录或全局 `.claude/settings.json`:
44
+
45
+ ```json
46
+ {
47
+ "mcpServers": {
48
+ "hvip": {
49
+ "command": "npx",
50
+ "args": ["-y", "hvip-mcp-server@latest"]
51
+ }
52
+ }
53
+ }
54
+ ```
55
+
56
+ ### VS Code / Cline / 其他 MCP 客户端
57
+
58
+ 在 MCP 配置中添加同样的 JSON。
59
+
60
+ > **配置完需要完全退出并重启客户端**,重开后 AI 自动连接 hvip。
61
+
62
+ ### 需要 API Key?
63
+
64
+ 行情、技术指标、市场扫描等公开数据无需 Key。查看账户、下单交易需要 OKX API Key:
65
+
66
+ ```json
67
+ {
68
+ "mcpServers": {
69
+ "hvip": {
70
+ "command": "npx",
71
+ "args": ["-y", "hvip-mcp-server"],
72
+ "env": {
73
+ "OKX_API_KEY": "<你的 API Key>",
74
+ "OKX_SECRET_KEY": "<你的 Secret Key>",
75
+ "OKX_PASSPHRASE": "<你的 Passphrase>"
76
+ }
77
+ }
78
+ }
79
+ }
80
+ ```
81
+
82
+ > API Key 在 [OKX 官网](https://www.okx.com) → 个人中心 → API 中创建,开通「读取」权限即可查账户,「交易」权限可下单。
83
+
84
+ ---
85
+
86
+ ## 工作流
87
+
88
+ AI 连接 hvip 后自动执行:
89
+
90
+ ```
91
+ 1. tools/list → 365 个工具,但只有 agent_catalog 带完整描述
92
+ 2. agent_catalog → 15 个域的地图(7 公开 + 8 需 Key),按需直达
93
+ 3. 用户说 "BTC 怎么样" → AI 调 okx_quick_market
94
+ 4. 用户说 "买 0.1 BTC" → AI 先预检再下单
95
+ ```
96
+
97
+ **无需手动操作,全程 AI 自己来。**
98
+
99
+ ---
100
+
101
+ ## 工具覆盖
102
+
103
+ | 模块 | 工具数 | 说明 |
104
+ |------|--------|------|
105
+ | 🔹 账户 | 40+ | 余额/持仓/配置/杠杆/估值 |
106
+ | 🔹 行情 | 17 | Ticker/K线/深度/成交 |
107
+ | 🔹 交易 | 27 | 下单/撤单/改单/批量/平仓 |
108
+ | 🔹 公共数据 | 34 | 产品规格/资金费率/标记价 |
109
+ | 🔹 资金 | 18 | 划转/提现/充值/兑换 |
110
+ | 🔹 策略委托 | 6 | 止损止盈/冰山/移动止盈 |
111
+ | 🔹 网格 | 13 | 现货网格/合约网格/定投 |
112
+ | 🔹 跟单 | 23 | 交易员/跟单/带单 |
113
+ | 🔹 信号 | 10 | 信号订阅/历史信号 |
114
+ | 🔹 价差 | 16 | 跨品种/跨期价差 |
115
+ | 🔹 RFQ | 12 | 大宗询价/报价/成交 |
116
+ | 🔹 金融 | 27 | 赚币/质押/借贷 |
117
+ | 🔹 预测市场 | 36 | 事件合约/预测交易 |
118
+ | 🔹 技术指标 | 2 | RSI/MACD/布林带等 17 种 |
119
+ | 🔹 聪明钱 | 3 | 交易员排行榜/市场情绪 |
120
+ | 🔹 WebSocket | 5 | 55 频道实时推送 |
121
+ | 🔹 代码图谱 | 2 | 函数调用链/符号搜索 |
122
+ | 🔹 系统工具 | 19 | 导航/偏好/反馈/Agent 协作 |
123
+
124
+ **365 个 MCP 工具 · 覆盖 97.7% OKX REST API**
125
+
126
+ ---
127
+
128
+ ## 本地开发
129
+
130
+ ```bash
131
+ git clone https://github.com/okx-wallet-H/hvip-mcp.git
132
+ cd hvip-mcp
133
+ npm install
134
+ npm run build
135
+ npm start
136
+ ```
137
+
138
+ ---
139
+
140
+ ## 架构
141
+
142
+ ```
143
+ 原子层 (350 工具) → [L:READ] 权限标记 → AI Agent 按需调用
144
+
145
+ Skill 组合层 (13 个) → 串联多工具,一次完成复杂任务
146
+
147
+ agent_catalog → 15 域地图 → 按意图路由 → 直达目标工具
148
+ ```
149
+
150
+ ---
151
+
152
+ ## 贡献
153
+
154
+ 1. 阅读 [`CLAUDE.md`](./CLAUDE.md) 了解项目规范
155
+ 2. 阅读 [`CONTRIBUTING.md`](./CONTRIBUTING.md) 了解提交流程
156
+ 3. Fork → 创建分支 → 开发 → `npm run build` → 提 PR
157
+
158
+ ---
159
+
160
+ ## 文档
161
+
162
+ - [`CLAUDE.md`](./CLAUDE.md) — AI Agent 项目指南
163
+ - [`CONTRIBUTING.md`](./CONTRIBUTING.md) — 贡献流程
164
+ - [`docs/OKX-MCP-API对接标准-v0.2.49.md`](./docs/OKX-MCP-API对接标准-v0.2.49.md) — API 对接规范
165
+ - [`docs/OKX-MCP-防幻觉对接SOP-v1.0.md`](./docs/OKX-MCP-防幻觉对接SOP-v1.0.md) — 防幻觉 SOP