Waroom MCP

[!VORSICHT] Dies ist noch ein experimentelles Projekt und es werden keine Stabilitäts- oder Leistungsgarantien gegeben. Bitte mit Vorsicht verwenden.

Dieses Projekt ist ein Model Context Protocol (MCP)-Server für die Interaktion mit der Waterum-API. Mittels standardisierter Protokolle können verschiedene Informationen aus dem Warroom abgerufen werden.

Überblick

Der Waroom MCP-Server bietet eine strukturierte Möglichkeit, auf die Waroom-API-Endpunkte zuzugreifen. Es unterstützt eine Vielzahl von Funktionen, einschließlich der Erfassung von Vorfall- und Post-Mortem-Informationen.

Related MCP server: Notion MCP Server

Anwendung

Um den Server zu starten, legen Sie die erforderlichen Umgebungsvariablen fest:

export WAROOM_API_KEY=your_api_key

Führen Sie als Nächstes den folgenden Befehl aus:

npx @topotal/waroom-mcp

Dadurch wird der MCP-Server gestartet und Sie können über die definierten Tools mit der Wateroom-API interagieren.

Verwendung mit Claude Desktop

Um diesen MCP-Server mit Claude Desktop zu verwenden, müssen Sie npx @topotal/waroom-mcp nicht manuell ausführen. Fügen Sie stattdessen Folgendes zu Ihrer Claude Desktop-Konfigurationsdatei hinzu:

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json

• Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "waroom-mcp": {
      "command": "npx",
      "args": ["@topotal/waroom-mcp"],
      "env": {
        "WAROOM_API_KEY": "your-api-key"
      }
    }
  }
}

Starten Sie anschließend Claude Desktop wie gewohnt. Wenn Sie nodenv oder nvm verwenden, müssen Sie möglicherweise den vollständigen Pfad zum npx Befehl angeben.

Verfügbare Tools

Dieser Model Context Protocol-Server bietet die folgenden Waroom-bezogenen Tools:

Vorfallbezogen

• waroom_get_incidents: Eine Liste der Vorfälle abrufen

• waroom_get_incident_details: Details zu einem bestimmten Vorfall abrufen

Postmortem-Bezogen

• waroom_get_postmortems: Liste der Postmortems abrufen

debuggen

Erstellen Sie zunächst das Projekt:

npm install
npm run build

MCP-Server laufen über stdio, daher kann das Debuggen schwierig sein. Für ein optimales Debugging-Erlebnis empfehlen wir dringend die Verwendung von MCP Inspector.

Sie können MCP Inspector über npm mit dem folgenden Befehl starten:

npx @modelcontextprotocol/inspector "./dist/main.js"

Stellen Sie sicher, dass Ihre Umgebungsvariablen richtig konfiguriert sind.

Nach dem Start zeigt Ihnen der Inspector eine URL an, die Sie in Ihrem Browser aufrufen können, um mit dem Debuggen zu beginnen.

Veröffentlichen

Um eine neue Version Ihres Pakets zu veröffentlichen, führen Sie die folgenden Schritte aus:

1. Ziehen Sie den neuesten Code aus dem Hauptzweig

   git checkout main
   git pull origin main

2. Erstellen des Pakets

   npm run build

3. Auf npm veröffentlichen

   npm publish

4. Übertragen Sie Ihre Änderungen in das Remote-Repository

   git push origin main --tags

Beitrag

Beiträge sind willkommen! Forken Sie das Repository und senden Sie Pull Requests für Verbesserungen und Fehlerbehebungen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert. Weitere Einzelheiten finden Sie in der Lizenzdatei.