Auvik

Auvik MCP Server

Auvik のネットワーク監視 API 用 MCP サーバーです。このサーバーには Auvik のネットワーク監視プラットフォームを操作するツールが用意されており、デバイス、ネットワーク、アラートなどを管理できます。

特長

• マルチテナント対応 - シングルテナントモードとゲートウェイモードの両方で動作します
• 包括的な API 対応 - Auvik API の主要なエンドポイントを網羅する 25 以上のツールを備えています
• 柔軟なトランスポート - HTTP と stdio の両方のトランスポートに対応しています
• 型安全 - TypeScript と Zod による検証を使用して構築されています
• Docker 対応 - コンテナー化されたソリューションとして利用できます

利用可能なツール

ステータスとナビゲーション

• auvik_status - サーバーのステータスと設定を確認します
• auvik_navigate - Auvik の UI とドキュメントへのナビゲーションリンクを取得します

テナント

• auvik_tenants_list - アクセス可能なすべてのテナントを一覧表示します
• auvik_tenants_get - テナントの基本情報を取得します
• auvik_tenants_detail - テナントの詳細情報を取得します

デバイス

• auvik_devices_list - ネットワークデバイスを一覧表示します
• auvik_devices_get - デバイスの基本情報を取得します
• auvik_devices_get_details - デバイスの詳細情報を取得します
• auvik_devices_get_warranty - デバイスの保証情報を取得します
• auvik_devices_get_lifecycle - デバイスのライフサイクル情報を取得します

ネットワーク

• auvik_networks_list - 検出されたネットワークを一覧表示します
• auvik_networks_get - ネットワーク情報を取得します

インターフェイス

• auvik_interfaces_list - ネットワークインターフェイスを一覧表示します

設定

• auvik_configurations_list - デバイス設定を一覧表示します
• auvik_configurations_get - 指定した設定を取得します

エンティティ

• auvik_entities_list_notes - エンティティのメモを一覧表示します
• auvik_entities_list_audits - エンティティの監査ログを一覧表示します

アラート

• auvik_alerts_list - アラート履歴を一覧表示します。filter_detectedTimeAfter/filter_detectedTimeBefore（ISO 8601）で最近のアラートに絞り込み、filter_status/filter_severity でフィルタリングできます。pageSize + pageAfter を使ってカーソルでページネーションを行い、返された nextPageAfter に従ってください。sort は可能な範囲でそのまま渡されます。
• auvik_alerts_get - 指定したアラートを取得します
• auvik_alerts_dismiss - アラートを解除／確認します

統計

• auvik_statistics_device - デバイスのパフォーマンス指標を取得します
• auvik_statistics_interface - インターフェイスのパフォーマンス指標を取得します
• auvik_statistics_service - サービスのパフォーマンス指標を取得します
• auvik_statistics_snmp_poller - SNMP ポーラーの指標を取得します

請求

• auvik_billing_client_usage - クライアントの請求対象使用量を取得します
• auvik_billing_device_usage - デバイスの請求対象使用量を取得します

生のリクエスト

• auvik_raw_request - 任意の Auvik エンドポイントに生のリクエストを送信します（method は GET/POST、path、省略可能な query/body）。変更されていない JSON:API レスポンスを返します。型付きツールでは公開されていないエンドポイントやパラメーターに使用できます。

インストール

環境変数

シングルテナントモード（stdio／直接接続）：

AUVIK_USERNAME=your_auvik_username
AUVIK_API_KEY=your_auvik_api_key
AUVIK_REGION=us1  # Optional: us1, us2, us3, us4, us5, us6, lnx, eu1, eu2, au1, ca1

stdio トランスポートはこれらの変数を読み取り、HTTP のサービス間認証の影響を受けません。

HTTP トランスポート：

CONDUIT_S2S_SECRET は必須です。空の場合、HTTP サーバーはエラーをログに記録してゼロ以外の終了コードで終了します。シークレットが出力されることはありません。シークレットなしで起動するには、ローカル開発時に限り MCP_ALLOW_INSECURE_DEV=1 を設定します。この場合、プロセスは重大な警告をログに記録し、X-Gateway-S2S を確認せず、127.0.0.1 のみでバインドします。このモードでは、ループバック以外の MCP_HTTP_HOST（0.0.0.0 を含む）は無視され、その上書きはログに記録されます。

MCP_HTTP_HOST が未設定の場合、デフォルトは 127.0.0.1 です。0.0.0.0 を設定するのは、CONDUIT_S2S_SECRET が設定されている場合に限ってください。コンテナーイメージではこの設定が行われ、AUTH_MODE=gateway も設定されます。

ゲートウェイモード（AUTH_MODE=gateway）：

すべての /mcp リクエストに、次のヘッダーを含める必要があります。

• x-auvik-username
• x-auvik-api-key
• x-auvik-region（省略可能）

ユーザー名または API キーが不足しているリクエストは 401 を返し、プロセス環境内の AUVIK_USERNAME／AUVIK_API_KEY へのフォールバックは行いません。CONDUIT_S2S_SECRET が設定されている場合、リクエストには有効な X-Gateway-S2S ヘッダーも含める必要があります。

シングルテナント HTTP（AUTH_MODE=env）：

/mcp では、引き続き有効な X-Gateway-S2S ヘッダーが必要です。リクエストに x-auvik-username と x-auvik-api-key が含まれていない場合、ベンダーの認証情報は AUVIK_* 環境変数から取得されます。

Docker

# Pull from GitHub Container Registry
docker pull ghcr.io/wyre-ai/auvik-mcp:latest

# Run with the gateway S2S secret. The image sets AUTH_MODE=gateway and
# MCP_HTTP_HOST=0.0.0.0; publish the port on loopback unless a proxy sits in front.
docker run -d \
  -p 127.0.0.1:8080:8080 \
  -e CONDUIT_S2S_SECRET="$CONDUIT_S2S_SECRET" \
  ghcr.io/wyre-ai/auvik-mcp:latest

Docker Compose

チェックイン済みの Compose サービスはゲートウェイモードです。AUVIK_USERNAME または AUVIK_API_KEY は設定されておらず、env_file も使用されないため、プロジェクトの .env からコンテナに固定のベンダー認証情報を渡すことはできません。Compose は引き続き、そのファイルから CONDUIT_S2S_SECRET と AUVIK_REGION を補間します。

version: '3.8'
services:
  auvik-mcp:
    image: ghcr.io/wyre-ai/auvik-mcp:latest
    ports:
      - "127.0.0.1:8080:8080"
    environment:
      - AUTH_MODE=gateway
      - AUVIK_REGION=${AUVIK_REGION:-us1}
      - CONDUIT_S2S_SECRET=${CONDUIT_S2S_SECRET:?set CONDUIT_S2S_SECRET}
      - MCP_HTTP_HOST=0.0.0.0

Docker でのシングルテナント HTTP（AUTH_MODE=env）

プロセス環境に認証情報を設定する、単一のテナントにのみ使用してください。上記のゲートウェイ Compose サービスとは別のものです。

services:
  auvik-mcp:
    image: ghcr.io/wyre-ai/auvik-mcp:latest
    ports:
      - "127.0.0.1:8080:8080"
    environment:
      - AUTH_MODE=env
      - AUVIK_USERNAME=${AUVIK_USERNAME:?set AUVIK_USERNAME}
      - AUVIK_API_KEY=${AUVIK_API_KEY:?set AUVIK_API_KEY}
      - AUVIK_REGION=${AUVIK_REGION:-us1}
      - CONDUIT_S2S_SECRET=${CONDUIT_S2S_SECRET:?set CONDUIT_S2S_SECRET}
      - MCP_HTTP_HOST=0.0.0.0

ローカル開発

git clone https://github.com/WYRE-AI/auvik-mcp.git
cd auvik-mcp
npm install
npm run build

# Run with stdio transport
npm start

# Run with HTTP transport (refuses to start until CONDUIT_S2S_SECRET is set)
CONDUIT_S2S_SECRET="$CONDUIT_S2S_SECRET" npm run start:http

# Local HTTP only, without a service-to-service secret (always binds 127.0.0.1)
MCP_ALLOW_INSECURE_DEV=1 npm run start:http

使用方法

MCP Gateway を使用する場合

このサーバーは WYRE の MCP Gateway と連携するように設計されています。ゲートウェイが認証とルーティングを処理します。

// Gateway automatically injects credentials and the X-Gateway-S2S proof
const response = await fetch('http://gateway:8080/mcp', {
  method: 'POST',
  headers: {
    'x-gateway-s2s': '<proof signed with CONDUIT_S2S_SECRET>',
    'x-auvik-username': 'your_username',
    'x-auvik-api-key': 'your_api_key',
    'x-auvik-region': 'us1',
    'content-type': 'application/json',
  },
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'tools/call',
    params: {
      name: 'auvik_devices_list',
      arguments: {}
    }
  })
});

直接使用する場合（stdio）

echo '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"auvik_status","arguments":{}}}' | npm start

API リージョン

Auvik は複数のリージョンで運用されています。適切なリージョンを設定してください。

• us1 - 米国東部（デフォルト）
• us2 - 米国西部
• us3 - 米国中部
• us4 - 米国南部
• us5 - 米国（新しいクラスター）
• us6 - 米国東部（オハイオ州）
• lnx - 米国東部（オハイオ州）
• eu1 - ヨーロッパ西部
• eu2 - ヨーロッパ中部
• au1 - オーストラリア
• ca1 - カナダ

エラー処理

サーバーは包括的なエラー処理を実装しています。

• 認証情報が無効な場合、401 エラーを返します
• リソースが見つからない場合、isError: true を含む、内容が明確な「見つかりません」メッセージを返します
• API のレート制限とサービスエラーを適切にマッピングします
• すべての応答に構造化されたエラー情報が含まれます

ヘルスチェック

サーバーは /health にヘルスエンドポイントを公開しており、常に 200 OK を返します。このエンドポイントでは認証は不要で、ベンダーの認証情報も読み取らないため、コンテナのヘルスチェックに適しています。

開発

# Install dependencies
npm install

# Run in development mode with file watching
npm run dev

# Run tests
npm test

# Type checking
npm run typecheck

# Lint
npm run lint

# Build
npm run build

貢献

貢献ガイドラインについては、CONTRIBUTING.md を参照してください。

ライセンス

Apache License 2.0 の下でライセンスされています。詳細については、LICENSE を参照してください。

サポート

• GitHub のイシュー
• Auvik API ドキュメント
• MCP プロトコルのドキュメント