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 die
@deque/axe-authCLI, mit Tokens, die in Ihrem Betriebssystem-Schlüsselspeicher gespeichert und automatisch aktualisiert werden.
Sie konfigurieren das gewählte Anmeldeinformation in Ihrem Client-Einrichtungsleitfaden. Jede Einrichtungsseite zeigt sowohl API-Schlüssel- als auch OAuth-Konfigurationen nebeneinander an.
Setzen Sie entweder AXE_API_KEY oder AXE_ACCESS_TOKEN — nicht beide. Der Server wird beim Start fehlschlagen, wenn beide Variablen gesetzt sind.
API-Schlüssel
- Melden Sie sich beim Axe Account-Portal an
- Navigieren Sie zu dem API-Schlüssel-Seite
- Klicken Sie auf NEUEN API-SCHLÜSSEL HINZUFÜGEN
- Wählen Sie Axe MCP Server als Produkt aus
- Geben Sie einen beschreibenden Namen für Ihren API-Schlüssel ein
- Klicken Sie auf Speichern
- Kopieren Sie den generierten API-Schlüssel — Sie werden ihn als
AXE_API_KEY-Umgebungsvariable an den Server übergeben
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 von @deque/axe-auth verwaltet, einer eigenständigen CLI, die separat auf Ihrem Host-Computer installiert wird.
Voraussetzungen
- Eine aktive Node.js LTS-Version
- Ihre gewählte axe MCP Server-Distribution ist 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 Computer ausführen. Bei nachfolgenden Aufrufen erneuert npx @deque/axe-auth token Ihr Zugriffstoken stillschweigend mit dem gespeicherten Erneuerungstoken.
Private Cloud, Nicht-US-Regionen oder lokale Installationen
Wenn Ihre Organisation eine private Cloud oder eine firmeninterne axe-Instanz verwendet, übergeben Sie die URL Ihrer Instanz mit --server (oder legen Sie die Umgebungsvariable AXE_SERVER_URL fest):
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 jedes Mal, wenn der Server startet, ein gültiges Zugriffstoken einzubinden. Wählen Sie Ihren Client für spezifische Einrichtungshinweise:
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 führt @deque/axe-auth token bei jedem Serverstart erneut aus, wodurch automatisch ein neues Token abgerufen wird.
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 Erneuerungstoken abgelaufen oder widerrufen wurde, beendet sich @deque/axe-auth token 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ätigungsaufforderung 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 auf https://axe.deque.com. Nur erforderlich für Privat-Cloud, Nicht-US-Regionen oder firmeninterne Installationen. |
--force |
Bestätigung der erneuten Authentifizierung überspringen, wenn bereits eingeloggt. |
--allow-insecure-issuer |
Erlauben Sie 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). Kann nicht gleichzeitig mit --allow-insecure-issuer verwendet werden. token und logout ignorieren diese Option. |
token
Gibt ein aktuell gültiges Zugriffstoken auf stdout aus. Aktualisiert stillschweigend, wenn das gespeicherte Token abgelaufen ist. Beendet sich 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 dessen 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. Kopflose oder minimale Desktop-Umgebungen haben möglicherweise keinen zur Verfügung. Wenn Sie einen Fehler wie diesen sehen:
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 Tokens wurden gelöscht. Führen Sie npx @deque/axe-auth login erneut aus, um sich erneut zu authentifizieren.
MCP-Server-Authentifizierungsfehler
- Bestätigen Sie, dass nur
AXE_ACCESS_TOKENgesetzt ist (nichtAXE_API_KEY) - Bestätigen Sie, dass
AXE_SERVER_URLIhrer axe-Instanz-URL entspricht — dies sollte die gleiche URL sein, die Sie während der Anmeldung mit--serververwendet haben (oderhttps://axe.deque.com, wenn 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 Code
1beendet wird, authentifizieren Sie sich erneut mitnpx @deque/axe-auth login
Linux-Schlüsselbund nicht verfügbar
Siehe den Plattformunterstützung-Hinweis oben.
