Zebpay MCP 服务器

生产就绪的 TypeScript MCP（模型上下文协议） 服务器，用于 Zebpay 现货和合约 API，仅使用 stdio 传输。 模型上下文协议（MCP）是 AI 助手安全调用工具和数据源的标准方式。 它专为通过本地进程执行连接的 MCP 客户端（如 Cursor、Claude Desktop 和 MCP Inspector）而设计。 该服务器提供市场数据和交易工作流，具备严格验证、安全错误处理以及开发者友好的可观测性。

该服务器提供的内容

• 公共市场数据工具（现货 + 合约）

• 私有交易/账户工具（需要 API 凭证）

• 用于代理工作流的 MCP 资源和提示

• 通过 Zod 进行请求验证

• 结构化错误处理和可选文件日志记录

Related MCP server: Cashfree MCP Server

功能特性

• 仅 stdio 的 MCP 服务器，用于与 MCP 客户端进行安全的本地集成

• 覆盖现货和合约的公共及认证操作 API

• 基于 HMAC 的私有端点认证请求流程

• 输入验证和标准化的 MCP 错误响应

• 出站请求重试和超时控制

• 可选的用于调试和审计的结构化文件日志记录

支持的工具

现货（公共 + 私有）

• 市场数据：行情、订单簿、K 线、成交记录、交易对信息、币种

• 交易：市价单、限价单、按订单取消、按交易对取消、全部取消

• 账户：余额、未成交订单、历史订单、历史成交、交易手续费

• 工具名称示例：

  • zebpay_public_getTicker

  • zebpay_public_getOrderBook

  • zebpay_spot_placeMarketOrder

  • zebpay_spot_placeLimitOrder

  • zebpay_spot_getBalance

合约（公共 + 私有）

• 市场数据：健康状态、交易对信息、订单簿、24 小时行情、聚合成交

• 交易/账户：钱包余额、下单、增加/减少保证金、未成交订单、持仓

• 历史记录：历史订单、关联订单、历史成交、历史资金流水

• 工具名称示例：

  • zebpay_futures_public_getMarkets

  • zebpay_futures_public_getOrderBook

  • zebpay_futures_placeOrder

  • zebpay_futures_getWalletBalance

  • zebpay_futures_getPositions

技术栈

• Node.js（ESM）

• TypeScript

• @modelcontextprotocol/sdk

• undici

• zod

项目结构

src/
├── index.ts                  # Stdio MCP server entrypoint
├── mcp/                      # Tools, resources, prompts, MCP errors/logging
├── private/                  # Authenticated Zebpay clients
├── public/                   # Public market-data clients
├── security/                 # Credentials + signing helpers
├── http/                     # Shared outbound HTTP client to Zebpay APIs
├── validation/               # Schemas and validation helpers
├── utils/                    # Caching, metrics, formatting, file logging
└── types/                    # Shared response types

环境要求

• Node.js 20+

• npm 9+

• Zebpay API 凭证（用于私有工具）

• 从官方 ZebPay API 门户创建您的 API 密钥/密钥：https://api.zebpay.com/

创建 ZebPay API 密钥

按照以下步骤生成此 MCP 服务器的 API 凭证：

1. 打开 ZebPay API 门户：https://api.zebpay.com/

2. 登录您的 ZebPay 账户。

3. 前往 API 交易 并点击 创建新 API 密钥。

4. 输入密钥详细信息：

   • 密钥名称（例如：zebpay-mcp-local）

   • 所需权限（市场/账户查询为只读，仅在需要时授予交易权限）

   • 可选的 IP 白名单（为获得更好的安全性，建议设置）

5. 完成 OTP 验证。

6. 复制并保存：

   • API 密钥

   • 密钥（仅显示一次）

然后将它们添加到您的本地 .env 文件中：

ZEBPAY_API_KEY=your_api_key
ZEBPAY_API_SECRET=your_api_secret

安全说明

• 切勿将 API 密钥/密钥提交到 git。

• 建议使用最小权限的 API 权限。

• 如果密钥泄露，请立即轮换。

设置

git clone <your-repo-url>
cd zebpay-mcp-server
npm install
cp env.example .env

更新 .env（所有值均从环境变量读取；代码中没有默认回退值）：

ZEBPAY_API_KEY=your_api_key    # Use the API key from the step above
ZEBPAY_API_SECRET=your_api_secret    # Use the Secret key from the step above
ZEBPAY_SPOT_BASE_URL=https://sapi.zebpay.com/api/v2
ZEBPAY_FUTURES_BASE_URL=https://futuresbe.zebpay.com/api/v1
ZEBPAY_MARKET_BASE_URL=https://www.zebapi.com/api/v1/market
MCP_TRANSPORTS=stdio
LOG_LEVEL=info
HTTP_TIMEOUT_MS=15000
HTTP_RETRY_COUNT=2

构建与运行

npm run build
npm start

可选的文件日志记录：

npm run start:log

MCP 客户端配置（Stdio）

MCP 客户端配置示例：

{
  "mcpServers": {
    "zebpay": {
      "command": "node",
      "args": [
          "/absolute/path/to/zebpay-mcp-server/dist/index.js"
        ],
      "env": {
        "ZEBPAY_API_KEY": "YOUR_API_KEY_HERE",
        "ZEBPAY_API_SECRET": "YOUR_API_SECRET_HERE",
        "LOG_LEVEL": "info"
      }
    }
  }
}

另请参阅：mcp-config.json.example。

环境变量

开发者命令

npm run build
npm test
npm run test:watch
npm run logs
npm run logs:watch
npm run logs:errors
npm run logs:stats
npm run logs:clear

日志记录

• 日志工具和示例：scripts/README.md

• 完整日志文档：docs/LOGGING.md

• 将日志排除在 git 之外（logs/ 已被忽略）

问题反馈

发现 Bug 或想要请求新功能？

• 从本仓库的 Issues 标签页创建问题。

• 您也可以在替换 <your-org> 和 <your-repo> 后使用直接链接：

  • Bug 报告：https://github.com/<your-org>/<your-repo>/issues/new?template=bug_report.md

  • 功能请求：https://github.com/<your-org>/<your-repo>/issues/new?template=feature_request.md

• 请包含以下详细信息以加快处理速度：

  • 使用的 MCP 客户端（Cursor/Claude Desktop/其他）

  • Node.js 版本和操作系统

  • 最小复现步骤

  • 相关日志（请对密钥进行脱敏处理）

许可证

MIT