使用说明
OKX MCP服务器
一种模型上下文协议(MCP)服务器,提供对OKX交易和投资组合管理功能的访问。该软件包允许AI助手与您的OKX账户交互,以检索投资组合信息、交易头寸、订单历史等。
此MCP服务器的设计将安全性作为首要任务。 以下是使用安全的原因:
🔒 内置安全功能
- 只读访问:服务器只需要读取权限-它不能进行交易或提取资金
- 本地处理:所有数据都在您的机器上本地处理,从不存储或传输给第三方
- 无数据持久性:您的交易数据永远不会保存到磁盘或永久缓存
- API直接通信:直接连接到OKX API,无需中间服务器
你能做什么
📱 在行动中看到它
示例:询问Claude“给我账户摘要”,立即从您的OKX账户数据中获取您的投资组合明细、资产配置和交易见解。
通过人工智能驱动的投资组合见解改变您的交易体验。 配置后,您可以向Claude提出有关OKX帐户的自然语言问题:
💰 投资组合管理
- “我目前的投资组合余额是多少?”
- “显示我的资产配置”
- “我拥有哪些硬币,它们值多少钱?”
- “我最大的价值是什么?”
📊 交易分析
- “显示我在损益表的未平仓头寸”
- “我有什么待处理的订单?”
- “分析我上个月的BTC交易历史”
- “我的ETH交易本周表现如何?”
🎯 智能洞察
- “我的未实现利润/亏损总额是多少?”
- “哪些资产获得了最大的价值?”
- “给我一份我的交易活动摘要”
- “我的投资组合今天表现如何?”
🔍 详细报告
- “创建我的投资组合的详细报告”
- “显示我所有已完成的BTC-USDT交易”
- “我这个月的交易量是多少?”
- “按百分比分解我的投资组合”
人工智能可以提供即时分析,生成见解,并帮助您做出明智的交易决策——所有这些都可以通过简单的对话来实现。
快速开始
步骤1:创建OKX API凭据
-
访问您的OKX帐户:
- 现有用户首选 OKX.com 网站 并登录
- 新用户:注册地址: OKX.com 网站 并完成账户验证
-
开放式API管理:
-
创建您的API密钥:
- 点击 “创建API密钥”
- 输入描述性名称(例如“MCP服务器”)
- 创建并保存安全 密码短语 (稍后你会需要这个)
-
设置只读权限:
- 阅读: ✅ 启用 (访问投资组合时需要)
- 贸易: ❌ 禁用 (此MCP服务器不需要)
- 提取: ❌ 禁用 (此MCP服务器不需要)
-
生成和复制凭据:
- 点击 “全部提交” 创建API密钥
- 点击 “显示信息” 显示您的凭据
- 点击 “复制API密钥信息” 复制所有详细信息
您的凭据将如下所示:
apikey = "12345678-abcd-1234-efgh-123456789abc" secretkey = "ABCD1234EFGH5678IJKL9012MNOP3456" IP = "" API key name = "MCP Server" Permissions = "Read" -
保护您的凭据:
- 保存 API密钥, 密钥,以及 口令短语 在安全的地方
- ⚠️ 关键的:密钥只显示一次-立即保存!
- 下一步将使用这些凭据配置Claude Desktop
步骤2:安装先决条件
在配置Claude Desktop之前,您需要安装Node.js。
安装Node.js
选项1:从官方网站下载
- 访问 https://nodejs.org
- 下载 LTS(长期支持) 适用于您的操作系统的版本
- 运行安装程序并按照安装向导进行操作
步骤3:配置Claude桌面
-
打开克劳德桌面设置:
- 启动克劳德桌面应用程序
- 点击 设置 (左下角的齿轮图标)
-
Access开发人员组:
- 向下滚动到设置面板的底部
- 点击 “开发人员” 章节
-
编辑配置:
- 点击 “编辑配置” 按钮
- 这将打开
claude_desktop_config.json默认文本编辑器中的文件
-
添加OKX MCP服务器配置:
- 用此配置替换整个文件内容:
{ "mcpServers": { "okx-mcp": { "command": "okx-mcp", "env": { "OKX_API_KEY": "your_api_key_here", "OKX_API_SECRET": "your_secret_key_here", "OKX_API_PASSPHRASE": "your_passphrase_here" } } } } -
更新您的凭据:
- 替换
your_api_key_here与你的实际 API密钥 从步骤1 - 替换
your_secret_key_here与你的实际 密钥 从步骤1 - 替换
your_passphrase_here与你的实际 口令短语 从步骤1 - 保存文件 并关闭文本编辑器
- 替换
-
重新启动克劳德桌面:
- 完全关闭克劳德桌面
- 重新打开应用程序以加载新配置
-
测试连接:
- 在Claude Desktop中启动新对话
- 试着问: “显示我的作品集” 或 “获取我的帐户摘要”
- 如果成功,Claude将检索并显示您的OKX帐户数据
可用工具
此MCP服务器为AI助手提供以下工具:
1.获取帐户摘要
- 工具:
get_account_summary - 描述:获取包括总价值和资产配置在内的汇总投资组合指标
- 参数:无
2.获取投资组合
- 工具:
get_portfolio - 描述:获取您账户中所有资产的详细信息
- 参数:无
- 退货:包含余额、可用金额和USDT价值的货币列表
3.获取职位
- 工具:
get_positions - 描述:获取所有未结衍生品交易头寸
- 参数:无
- 退货:头寸详情,包括规模、入市价格和未实现损益
4.获取未结订单
- 工具:
get_open_orders - 描述:获取所有当前未结的交易订单
- 参数:无
- 退货:订单详细信息,包括符号、类型、价格和状态
5.获取订单历史记录
- 工具:
get_order_history - 描述:获取历史已完成订单以供分析
- 参数:
instId(必填):工具ID(例如“BTC-USDT”)begin(可选):开始时间戳end(可选):结束时间戳
- 退货:具有执行详细信息的历史订单数据
发展
地方发展
# Clone the repository
git clone https://github.com/maxbarinov/okx-mcp.git
cd okx-mcp
# Install dependencies
npm install
# Set up environment variables
cp .env.example .env
# Edit .env with your OKX API credentials
# Run in development mode
npm run dev
建筑
npm run build
项目结构
src/
├── services/
│ └── okxApiClient.ts # OKX API client wrapper
└── tools/ # MCP tool implementations
├── get_account_summary.ts
├── get_portfolio.ts
├── get_positions.ts
├── get_open_orders.ts
└── get_order_history.ts
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 如果适用,添加测试
- 提交拉取请求
许可证
麻省理工学院
支持
如果您遇到任何问题或有疑问:
- 检查 GitHub问题
- 使用有关您问题的详细信息创建新问题
- 包括您的环境详细信息和错误消息(不包括敏感数据)