Zebpay MCP Server

Produktionsreifer TypeScript-MCP (Model Context Protocol)-Server für Zebpay-Spot- und Futures-APIs, der ausschließlich stdio-Transport verwendet. Das Model Context Protocol (MCP) ist ein Standardweg für KI-Assistenten, um sicher auf Tools und Datenquellen zuzugreifen. Es ist für MCP-Clients wie Cursor, Claude Desktop und MCP Inspector konzipiert, die über lokale Prozessausführung verbunden werden. Der Server bietet sowohl Marktdaten- als auch Handels-Workflows mit strenger Validierung, sicherer Fehlerbehandlung und entwicklerfreundlicher Beobachtbarkeit.

Was dieser Server bietet

• Öffentliche Marktdaten-Tools (Spot + Futures)

• Private Handels-/Kontotools (erfordert API-Anmeldedaten)

• MCP-Ressourcen und Prompts für Agent-Workflows

• Anfragevalidierung über Zod

• Strukturierte Fehlerbehandlung und optionale Dateiprotokollierung

Related MCP server: Cashfree MCP Server

Funktionen

• Nur-Stdio-MCP-Server für sichere lokale Integration mit MCP-Clients

• Abdeckung der Spot- und Futures-APIs für öffentliche und authentifizierte Vorgänge

• HMAC-basierter authentifizierter Anfragefluss für private Endpunkte

• Eingabevalidierung und normalisierte MCP-Fehlerantworten

• Wiederholungs- und Timeout-Steuerung für ausgehende Anfragen

• Optionale strukturierte Dateiprotokollierung für Debugging und Prüfbarkeit

Unterstützte Tools

Spot (Öffentlich + Privat)

• Marktdaten: Ticker, Orderbuch, Trades, Klines, Börseninformationen, Währungen

• Handel: Markt-/Limit-Orders platzieren, Orders stornieren, nach Symbol stornieren, alle stornieren

• Konto: Guthaben, offene Orders, Orderhistorie, Tradehistorie, Börsengebühr

• Beispiel-Toolnamen:

  • zebpay_public_getTicker

  • zebpay_public_getOrderBook

  • zebpay_spot_placeMarketOrder

  • zebpay_spot_placeLimitOrder

  • zebpay_spot_getBalance

Futures (Öffentlich + Privat)

• Marktdaten: Gesundheitsstatus, Märkte, Marktinformationen, Orderbuch, 24h-Ticker, aggregierte Trades

• Handel/Konto: Wallet-Guthaben, Order platzieren, Margin hinzufügen/reduzieren, offene Orders, Positionen

• Verlauf: Orderhistorie, verknüpfte Orders, Tradehistorie, Transaktionshistorie

• Beispiel-Toolnamen:

  • zebpay_futures_public_getMarkets

  • zebpay_futures_public_getOrderBook

  • zebpay_futures_placeOrder

  • zebpay_futures_getWalletBalance

  • zebpay_futures_getPositions

Technologie-Stack

• Node.js (ESM)

• TypeScript

• @modelcontextprotocol/sdk

• undici

• zod

Projektstruktur

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

Voraussetzungen

• Node.js 20+

• npm 9+

• Zebpay-API-Anmeldedaten (für private Tools)

• Erstellen Sie Ihren API-Schlüssel/Geheimnis über das offizielle ZebPay-API-Portal: https://api.zebpay.com/

Erstellen eines ZebPay-API-Schlüssels

1. Öffnen Sie das ZebPay-API-Portal: https://api.zebpay.com/

2. Melden Sie sich bei Ihrem ZebPay-Konto an.

3. Gehen Sie zu API Trading und klicken Sie auf Create New API Key.

4. Geben Sie Schlüsseldetails ein:

   • Schlüsselname (z. B. zebpay-mcp-local)

   • erforderliche Berechtigungen (nur Lesen für Markt-/Kontoprüfungen, Handelsberechtigungen nur bei Bedarf)

   • optionale IP-Whitelist (für bessere Sicherheit empfohlen)

5. Schließen Sie die OTP-Verifizierung ab.

6. Kopieren und speichern Sie:

   • API-Schlüssel

   • Geheimschlüssel (wird nur einmal angezeigt)

Fügen Sie sie dann zu Ihrer lokalen .env-Datei hinzu:

ZEBPAY_API_KEY=your_api_key
ZEBPAY_API_SECRET=your_api_secret

Sicherheitshinweise:

• Committen Sie API-Schlüssel/Geheimnisse niemals in Git.

• Bevorzugen Sie API-Berechtigungen mit geringsten Rechten.

• Rotieren Sie Schlüssel sofort, wenn sie offengelegt wurden.

Einrichtung

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

Aktualisieren Sie .env (alle Werte werden aus der Umgebung gelesen; es gibt keine Fallback-Standardwerte im Code):

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

Erstellen und Ausführen

npm run build
npm start

Optionale Protokollierung in Datei:

npm run start:log

MCP-Client-Konfiguration (Stdio)

Beispiel-MCP-Client-Konfiguration:

{
  "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"
      }
    }
  }
}

Siehe auch: mcp-config.json.example.

Umgebungsvariablen

Entwicklerbefehle

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

Protokollierung

• Tools und Beispiele protokollieren: scripts/README.md

• Vollständige Protokollierungsdokumentation: docs/LOGGING.md

• Protokolle aus Git heraushalten (logs/ wird ignoriert)

Probleme

Einen Fehler gefunden oder ein Feature anfragen?

• Erstellen Sie ein Issue über den GitHub-Tab Issues für dieses Repository.

• Sie können auch direkte Links verwenden, nachdem Sie <your-org> und <your-repo> ersetzt haben:

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

  • Feature-Anfrage: https://github.com/<your-org>/<your-repo>/issues/new?template=feature_request.md

• Fügen Sie diese Details für eine schnellere Bearbeitung hinzu:

  • Verwendeter MCP-Client (Cursor/Claude Desktop/andere)

  • Node.js-Version und Betriebssystem

  • Minimale Reproduktionsschritte

  • Relevante Protokolle (Geheimnisse schwärzen)

Lizenz

MIT