Authentifizierung
Der Axe-MCP-Server unterstützt zwei Authentifizierungsmethoden. Beide stehen allen Nutzern zur Verfügung – wählen Sie diejenige, die zu Ihrem Workflow passt:
- API-Schlüssel – ein langlebiger Schlüssel, der im Axe Account-Portal generiert wird. Am einfachsten einzurichten.
- OAuth 2.0 – browserbasierte Anmeldung über das
@deque/axe-authCLI, wobei Tokens in Ihrem Betriebssystem-Schlüsselbund gespeichert und automatisch aktualisiert werden.
Sie konfigurieren die gewählte Berechtigung in Ihrem Client-Einrichtungsleitfaden. Jede Einrichtungsseite zeigt sowohl API-Schlüssel- als auch OAuth-Konfigurationen nebeneinander.
Legen Sie entweder AXE_API_KEY oder AXE_ACCESS_TOKEN fest — nicht beide. Der Server wird beim Start fehlschlagen, wenn beide Variablen gesetzt sind.
API-Schlüssel
- Melden Sie sich im Axe Account-Portal
- Navigieren Sie zur API-Schlüssel-Seite
- Klicken Sie auf NEUEN API-SCHLÜSSEL HINZUFÜGEN
- Wählen Sie Axe MCP Server als Produkt
- Geben Sie einen beschreibenden Namen für Ihren API-Schlüssel ein
- Klicken Sie auf Speichern
- Kopieren Sie den generierten API-Schlüssel – Sie übergeben ihn an den Server als
AXE_API_KEYUmgebungsvariable
OAuth 2.0
OAuth 2.0 verwendet den Authorization Code Flow mit PKCE und speichert Tokens sicher in Ihrem Betriebssystem-Schlüsselbund, sodass Sie sich einmal authentifizieren und das CLI die Token-Aktualisierung automatisch übernimmt.
Die Authentifizierung wird verwaltet von @deque/axe-auth, einem eigenständigen CLI, das Sie separat auf Ihrem Host-Rechner installieren.
Voraussetzungen
- Eine aktive Node.js LTS-Version
- Ihre gewählte Axe-MCP-Server-Distribution installiert – siehe Eine Distribution wählen
Schritt 1: Authentifizieren
Führen Sie den Login-Befehl aus:
npx @deque/axe-auth loginDas CLI wird:
- Ihren Standardbrowser zur Anmeldeseite öffnen
- Sie auffordern, sich mit Ihren Axe-Account-Anmeldeinformationen anzumelden
- Die resultierenden Tokens sicher in Ihrem System-Schlüsselbund speichern
Möglicherweise fordert Ihr Betriebssystem Sie beim ersten Speichern von Tokens dazu auf, den Zugriff auf den Schlüsselbund zu gewähren.
Nachdem dies abgeschlossen ist, bestätigt das Terminal:
✓ Authenticated.Sie müssen login nur einmal pro Gerät ausführen. Bei späteren Aufrufen npx @deque/axe-auth token aktualisiert Ihr Zugriffstoken leise mit dem gespeicherten Aktualisierungs-Token.
Private Cloud, Nicht-US-Regionen oder lokale Installationen
Wenn Ihre Organisation eine private Cloud oder eine lokale Axe-Instanz verwendet, geben Sie Ihre Instanz-URL mit --server (oder setzen Sie AXE_SERVER_URL Umgebungsvariable):
npx @deque/axe-auth login --server https://your-axe-instance.example.comSchritt 2: Konfigurieren Sie Ihren Client
Verwenden Sie @deque/axe-auth token in Ihrer MCP-Clientkonfiguration, um bei jedem Serverstart ein gültiges Zugriffstoken zu injizieren. Wählen Sie Ihren Client für spezifische Setup-Anweisungen:
Jede Setup-Seite enthält einen OAuth-Konfigurationsabschnitt neben den API-Schlüssel-Anweisungen.
Sitzungen verwalten
Token-Lebensdauer
OAuth-Zugriffstoken sind kurzlebig. Wenn eine Sitzung länger dauert als die Lebensdauer des Tokens, gibt der Server Authentifizierungsfehler zurück.
Abhilfe: Starten Sie die MCP-Serververbindung in Ihrem Client neu. Die Konfiguration wird bei jedem Serverstart erneut ausgeführt, @deque/axe-auth token was automatisch ein neues Token abruft.
Abmelden
Um Ihre Tokens serverseitig zu widerrufen und aus dem System-Schlüsselbund zu löschen:
npx @deque/axe-auth logoutWenn der serverseitige Widerruf fehlschlägt (z. B. aufgrund eines Netzwerkfehlers), werden lokale Tokens dennoch gelöscht und eine Warnung wird ausgegeben.
Erneutes Authentifizieren
Wenn Ihr Auffrischungstoken abgelaufen oder widerrufen wurde, @deque/axe-auth token beendet mit Code 1 und fordert Sie auf, sich erneut anzumelden. Führen Sie npx @deque/axe-auth login erneut aus. Übergeben Sie --force um die Bestätigungsmeldung zur erneuten Authentifizierung zu überspringen:
npx @deque/axe-auth login --forceBefehlsreferenz
login
Öffnet einen Browser, führt den OAuth 2.0 Authorization Code + PKCE Flow durch und speichert Tokens im Betriebssystem-Schlüsselbund.
npx @deque/axe-auth login [options]| Flag | Beschreibung |
|---|---|
--server <url> |
Basis-URL Ihrer Axe-Instanz. Standardmäßig https://axe.deque.com. Nur für private Cloud, nicht-US-Regionen oder lokale Installationen erforderlich. |
--force |
Bestätigung der erneuten Authentifizierung überspringen, wenn bereits eingeloggt. |
--allow-insecure-issuer |
Erlauben von nicht-Loopback-HTTP-URLs (Standard ist nur HTTPS; Loopback-HTTP ist immer erlaubt). Gilt nur für login ; token und logout verwenden die bei der Anmeldung gespeicherte Richtlinie. |
--no-allow-insecure-issuer |
Erzwingen Sie allowInsecureIssuer=false für das neue login (und den Eintrag, den es speichert). Unvereinbar mit --allow-insecure-issuer. token und logout ignorieren dieses Flag. |
token
Gibt ein aktuell gültiges Zugriffstoken auf stdout aus. Aktualisiert sich stillschweigend, wenn das gespeicherte Token abgelaufen ist. Beendet mit Code 1 wenn nicht authentifiziert.
npx @deque/axe-auth tokenlogout
Widerruft das gespeicherte Auffrischungstoken serverseitig und löscht den lokalen Schlüsselbund-Eintrag.
npx @deque/axe-auth logout--help
Zeigt Hilfeinformationen für @deque/axe-auth und seine Befehle an.
npx @deque/axe-auth --help
npx @deque/axe-auth <command> --helpPlattformunterstützung
| Plattform | Token-Speicherung |
|---|---|
| macOS | macOS-Schlüsselbund |
| Windows | Windows-Anmeldeinformationsverwaltung |
| Linux | D-Bus Secret Service (GNOME Keyring, KWallet, etc.) |
Linux: @deque/axe-auth erfordert einen funktionierenden D-Bus Secret Service. Headless- oder Minimal-Desktop-Umgebungen haben möglicherweise keinen. Wenn ein Fehler wie folgt auftritt:
System keychain load failed: <details>. On Linux this usually means no D-Bus Secret Service is running (e.g. GNOME Keyring or KWallet).bitten Sie Ihren Systemadministrator, GNOME Keyring oder einen kompatiblen Secret-Service-Anbieter zu konfigurieren.
OAuth-Fehlerbehebung
Browser öffnet sich nicht automatisch
Wenn login keinen Browser öffnen kann, wird die Autorisierungs-URL im Terminal angezeigt. Kopieren Sie die URL und öffnen Sie sie manuell, um die Authentifizierung abzuschließen.
Token-Ablauf bei langen Sitzungen
Siehe Token-Lebensdauer oben. Starten Sie die MCP-Serververbindung in Ihrem Client neu, um ein neues Token zu erhalten.
„Nicht authentifiziert“-Fehler von token
Ihre Sitzung ist abgelaufen oder die Tokens wurden gelöscht. Führen Sie npx @deque/axe-auth login erneut aus, um sich neu zu authentifizieren.
MCP-Server-Authentifizierungsfehler
- Bestätigen Sie, dass nur
AXE_ACCESS_TOKENgesetzt ist (nichtAXE_API_KEY) - Bestätigen Sie, dass
AXE_SERVER_URLmit Ihrer axe-Instanz-URL übereinstimmt — dies sollte die gleiche URL sein, die beim--serverwährend des Logins verwendet wurde (oderhttps://axe.deque.comwenn Sie den Standard verwendet haben) - Führen Sie
npx @deque/axe-auth tokendirekt in Ihrem Terminal aus, um zu bestätigen, dass Sie ein gültiges Token haben - Wenn es mit dem Code endet
1, authentifizieren Sie sich erneut mitnpx @deque/axe-auth login
Linux-Schlüsselbund nicht verfügbar
Siehe den Hinweis Plattformunterstützung oben.
