Okx MCP

🚀 OKX MCP 服务器

OKX MCP 服务器是一个模型上下文协议（MCP）服务器，它提供对 OKX 交易和投资组合管理功能的访问。此软件包允许 AI 助手与你的 OKX 账户进行交互，以检索投资组合信息、交易头寸、订单历史记录等。

🔒 安全性至上

该 MCP 服务器在设计时将安全性作为首要考虑因素，以下是其安全特性：

• 只读访问：服务器仅需要读取权限，无法进行交易或提取资金。
• 本地处理：所有数据都在本地机器上处理，不会存储或传输给第三方。
• 无数据持久化：你的交易数据不会保存到磁盘或永久缓存。
• 直接 API 通信：直接连接到 OKX API，无需中间服务器。

🚀 快速开始

步骤 1：创建 OKX API 凭证

1. 访问你的 OKX 账户：
   • 现有用户：访问 OKX.com 并登录。
   • 新用户：在 OKX.com 注册并完成账户验证。
2. 打开 API 管理： 直接访问：https://www.okx.com/account/my-api
3. 创建你的 API 密钥：
   • 点击 “创建 API 密钥”。
   • 输入描述性名称（例如，“MCP 服务器”）。
   • 创建并保存一个安全的 密码短语（稍后会用到）。
4. 设置只读权限：
   • 读取：✅ 启用（访问投资组合必需）
   • 交易：❌ 禁用（此 MCP 服务器不需要）
   • 提现：❌ 禁用（此 MCP 服务器不需要）
5. 生成并复制凭证：
   • 点击 “全部提交” 创建 API 密钥。
   • 点击 “显示信息” 显示凭证。
   • 点击 “复制 API 密钥信息” 复制所有详细信息。 你的凭证将如下所示：

   apikey = "12345678-abcd-1234-efgh-123456789abc"
   secretkey = "ABCD1234EFGH5678IJKL9012MNOP3456"
   IP = ""
   API 密钥名称 = "MCP 服务器"
   权限 = "读取"
   

6. 保护你的凭证：
   • 将 API 密钥、秘密密钥 和 密码短语 保存在安全的位置。
   • ⚠️ 重要提示：秘密密钥仅显示一次，请立即保存！
   • 这些凭证将用于下一步配置 Claude Desktop。

步骤 2：安装先决条件

在配置 Claude Desktop 之前，你需要安装 Node.js。

安装 Node.js

选项 1：从官方网站下载

1. 访问 https://nodejs.org。
2. 下载适合你操作系统的 LTS（长期支持） 版本。
3. 运行安装程序并按照设置向导操作。

步骤 3：配置 Claude Desktop

1. 打开 Claude Desktop 设置：
   • 启动 Claude Desktop 应用程序。
   • 点击 设置（左下角的齿轮图标）。
2. 访问开发者部分：
   • 滚动到设置面板底部。
   • 点击 “开发者” 部分。
3. 编辑配置：
   • 点击 “编辑配置” 按钮。
   • 这将在默认文本编辑器中打开 claude_desktop_config.json 文件。
4. 添加 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"
         }
       }
     }
   }
   

5. 更新你的凭证：
   • 将 your_api_key_here 替换为你在步骤 1 中获取的实际 API 密钥。
   • 将 your_secret_key_here 替换为你在步骤 1 中获取的实际 秘密密钥。
   • 将 your_passphrase_here 替换为你在步骤 1 中获取的实际 密码短语。
   • 保存文件 并关闭文本编辑器。
6. 重启 Claude Desktop：
   • 完全关闭 Claude Desktop。
   • 重新打开应用程序以加载新配置。
7. 测试连接：
   • 在 Claude Desktop 中开始新对话。
   • 尝试询问：“显示我的投资组合” 或 “获取我的账户摘要”。
   • 如果成功，Claude 将检索并显示你的 OKX 账户数据。

✨ 主要特性

📱 实际效果展示

示例：向 Claude 询问“给出我的账户摘要”，即可立即获取你的投资组合明细、资产分配和交易洞察——所有数据均来自你的 OKX 账户。

借助 AI 驱动的投资组合洞察，改变你的交易体验。配置完成后，你可以用自然语言向 Claude 询问有关 OKX 账户的问题：

💰 投资组合管理

• “我当前的投资组合余额是多少？”
• “展示我的资产分配情况”
• “我持有哪些加密货币，它们的价值是多少？”
• “按价值计算，我最大的持仓是什么？”

📊 交易分析

• “展示我的持仓及盈亏情况”
• “我有哪些待处理的订单？”
• “分析我上个月的比特币交易历史”
• “我本周的以太坊交易表现如何？”

🎯 智能洞察

• “我的总未实现盈亏是多少？”
• “哪些资产增值最多？”
• “给出我的交易活动摘要”
• “我今天的投资组合表现如何？”

🔍 详细报告

• “生成我的投资组合详细报告”
• “展示我所有已完成的比特币 - 美元交易”
• “我本月的交易成交量是多少？”
• “按百分比分解我的投资组合”

AI 可以通过简单的对话提供即时分析、生成洞察并帮助你做出明智的交易决策。

📦 安装指南

本地开发

# 克隆仓库
git clone https://github.com/maxbarinov/okx-mcp.git
cd okx-mcp

# 安装依赖
npm install

# 设置环境变量
cp .env.example .env
# 用你的 OKX API 凭证编辑 .env

# 在开发模式下运行
npm run dev

构建

npm run build

💻 使用示例

可用工具

此 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（可选）：结束时间戳
• 返回：包含执行细节的历史订单数据。

🔧 技术细节

项目结构

src/
├── services/
│   └── okxApiClient.ts    # OKX API 客户端包装器
└── tools/                # MCP 工具实现
    ├── get_account_summary.ts
    ├── get_portfolio.ts
    ├── get_positions.ts
    ├── get_open_orders.ts
    └── get_order_history.ts

🤝 贡献指南

1. 分叉仓库。
2. 创建功能分支。
3. 进行更改。
4. 如有必要，添加测试。
5. 提交拉取请求。

📄 许可证

本项目采用 MIT 许可证。

📞 支持

如果你遇到任何问题或有疑问：

1. 查看 GitHub 问题。
2. 创建一个新问题，并详细描述你的问题。
3. 提供你的环境详细信息和错误消息（不包含敏感数据）。

🔗 相关项目

• 模型上下文协议
• xmcp 框架
• OKX API 文档