認証
axe MCPサーバーは2つの認証方法をサポートしています。どちらも全てのユーザーが利用可能で、ワークフローに合った方法を選択してください。
- APIキー — axeアカウントポータルで生成された長期間使用可能なキー。最も簡単なセットアップです。
- OAuth 2.0 — ブラウザーベースのログイン、
@deque/axe-authCLIを介し、トークンはOSのキーチェーンに保存され、自動で更新されます。
選択した認証情報をクライアントセットアップガイドで設定します。各セットアップページには、APIキーとOAuthの設定が並んで表示されます。
AXE_API_KEYかAXE_ACCESS_TOKENのどちらか一方を設定してください。両方の変数を設定すると、サーバーは起動時に失敗します。
APIキー
- axeアカウントポータルにログインしてください
- APIキーのページへ移動してください
- 新しいAPIキーを追加をクリックしてください
- axe MCPサーバーを製品として選択してください
- APIキーの説明名を入力します
- 保存をクリックしてください
- 生成されたAPIキーをコピーします — サーバーへの
AXE_API_KEY環境変数として渡します
OAuth 2.0
OAuth 2.0はPKCEを用いた認可コードフローを使用し、トークンをOSのキーチェーンに安全に保存します。これにより、1度認証を行うだけで、CLIがトークンの更新を自動で行います。
認証は@deque/axe-authによって管理されます。これはホストマシンに別途インストールするスタンドアロンのCLIです。
前提条件
- アクティブなNode.js LTSリリース
- 選択したaxe MCPサーバーディストリビューションがインストールされています — 配布版の選択をご覧ください
ステップ1: 認証
ログインコマンドを実行します。
npx @deque/axe-auth loginCLIの動作:
- デフォルトのブラウザを開き、ログインページを表示
- axeアカウントの認証情報でサインインを促す
- 結果のトークンをシステムキーチェーンに安全に保存
トークンが初めて保存される際に、OSがキーチェーンアクセスの許可を求める場合があります。
完了すると、ターミナルに確認メッセージが表示されます。
✓ Authenticated.loginをマシンごとに一度だけ実行する必要があります。次の起動時には、npx @deque/axe-auth tokenは保存されたリフレッシュトークンを使用してアクセス・トークンを静かに更新します。
プライベートクラウド、米国外、またはオンプレミスのインストール
組織がプライベートクラウドやオンプレミスのaxeインスタンスを使用している場合、--serverでインスタンスURLを渡します(またはAXE_SERVER_URL環境変数を設定します):
npx @deque/axe-auth login --server https://your-axe-instance.example.comステップ2: クライアントの設定
MCPクライアント構成で@deque/axe-auth tokenを使用して、サーバーが起動するたびに有効なアクセストークンを注入します。特定のセットアップ説明についてはクライアントを選択してください:
各セットアップページには、APIキーの指示に加えてOAuth構成セクションが含まれています。
セッションの管理
トークンの有効期間
OAuthアクセス・トークンは短命です。セッションがトークンの有効期限を超えて継続すると、サーバーは認証エラーを返します。
回避策: MCPサーバー接続をクライアントで再起動します。構成は、サーバー起動ごとに@deque/axe-auth tokenを再実行し、自動的に新しいトークンを取得します。
ログアウト
サーバー側でトークンを無効化し、システムキーチェーンから削除するには:
npx @deque/axe-auth logoutサーバー側の無効化が失敗した場合(たとえばネットワークエラーによる)、ローカルトークンはクリアされ警告が表示されます。
再認証
リフレッシュトークンが期限切れまたは取り消された場合、@deque/axe-auth tokenはコード1で終了し、再ログインするよう指示します。再度npx @deque/axe-auth loginを実行してください。再認証確認プロンプトをスキップするには--forceを渡します:
npx @deque/axe-auth login --forceコマンドリファレンス
login
ブラウザを開き、OAuth 2.0 Authorization Code + PKCEフローを完了し、トークンをOSキーチェーンに保存します。
npx @deque/axe-auth login [options]| フラグ | 説明 |
|---|---|
--server <url> |
axeインスタンスのベースURL。デフォルトはhttps://axe.deque.comです。プライベートクラウド、非US地域、またはオンプレミスのインストールでのみ必要です。 |
--force |
既にログインしている場合、再認証確認をスキップします。 |
--allow-insecure-issuer |
非ループバックhttp URLを許可(デフォルトはhttpsのみ;ループバックhttpは常に許可されます)。loginのみに適用されます;tokenとlogoutはログイン時に保持されたポリシーを使用します。 |
--no-allow-insecure-issuer |
allowInsecureIssuer=falseを新しいlogin(およびそれが保持するエントリ)に強制します。--allow-insecure-issuerとは相互排他的です。tokenとlogoutはこのフラグを無視します。 |
token
現在有効なアクセストークンをstdoutに出力します。保存されたトークンが期限切れの場合、静かに更新されます。認証されていない場合、コード1で終了します。
npx @deque/axe-auth tokenlogout
保存されたリフレッシュトークンをサーバー側で無効化し、ローカルキーチェーンをクリアします。
npx @deque/axe-auth logout--help
@deque/axe-authおよびそのコマンドに関するヘルプ情報を表示します。
npx @deque/axe-auth --help
npx @deque/axe-auth <command> --helpプラットフォームサポート
| プラットフォーム | トークン保管 |
|---|---|
| macOS | macOSキーチェーン |
| Windows | Windowsクレデンシャルマネージャー |
| Linux | D-Busシークレットサービス(GNOME Keyring、KWalletなど) |
Linux: @deque/axe-authはD-Bus Secret Serviceが動作している必要があります。ヘッドレスまたはミニマルデスクトップ環境では利用できない場合があります。以下のようなエラーが表示された場合:
System keychain load failed: <details>. On Linux this usually means no D-Bus Secret Service is running (e.g. GNOME Keyring or KWallet).システム管理者にGNOME Keyringまたは互換性のあるシークレットサービスプロバイダを設定するよう依頼してください。
OAuthのトラブルシューティング
ブラウザが自動的に開かない
loginがブラウザを開けない場合、認証URLを端末に表示します。URLをコピーして手動で開き、認証を完了してください。
長時間のセッション中のトークンの期限切れ
上記のトークンの有効期間を参照してください。クライアントでMCPサーバー接続を再起動して新しいトークンを取得してください。
tokenからの「認証されていません」エラー
セッションが期限切れになったか、トークンがクリアされました。再認証するには再度npx @deque/axe-auth loginを実行してください。
MCPサーバーの認証エラー
AXE_ACCESS_TOKENのみが設定されていることを確認してください(AXE_API_KEYはされていません)AXE_SERVER_URLがaxeインスタンスURLと一致していることを確認してください — これはログイン時に--serverと一緒に使用したのと同じURLである必要があります(デフォルトを使用した場合はhttps://axe.deque.com)- 有効なトークンを持っていることを確認するために
npx @deque/axe-auth tokenを直接端末で実行してください - コード
1で終了した場合、npx @deque/axe-auth loginで再認証してください
」を上記の注記を参照してください。
上記のプラットフォームサポートの記述を参照してください。
