UpGuard CyberRisk MCP Server

UpGuard CyberRisk MCP Server

UpGuard の CyberRisk API と連携する Model Context Protocol（MCP）サーバーです。このサーバーは、標準化されたインターフェースを通じて、包括的なセキュリティリスクの評価と管理機能を提供します。

特長

• セキュリティ管理を網羅する 13 カテゴリーの 67 個の API ツール
• 複雑な操作向けの高度なワークフロープロンプト 8 個を含む 25 個の包括的なプロンプト
• ベンダーの監視と侵害の検出を含む リアルタイムのリスク評価
• 複数の出力形式に対応した ドキュメントの自動生成
• Swagger UI と Redoc インターフェースを備えた 対話型 API エクスプローラー
• Zod スキーマ定義 22 個による 包括的なスキーマ検証
• ドキュメントの自動デプロイに対応した CI/CD 連携

強化されたプロンプト（v1.4.0 の新機能）

このサーバーには、複雑なセキュリティ操作のためのガイド付きワークフローを提供する 25 個の包括的なプロンプト（強化されたプロンプト 8 個＋既存のプロンプト 17 個）が含まれるようになりました。

🔴 リスク管理プロンプト

• upguard_comprehensive_risk_assessment - 包括的なリスク評価ワークフロー
• upguard_risk_trend_analysis - 複数期間にわたるリスク傾向の分析
• upguard_account_risk_dashboard：アカウントのリスクダッシュボードを作成します。
• upguard_risk_trend_analysis_original：指定された期間のリスク傾向を分析します。
• upguard_risk_severity_analysis：重大度別にリスクを分析します。
• upguard_critical_risk_prioritization：重大なリスクに優先順位を付けます。
• upguard_risk_type_analysis：種類別にリスクを分析します。
• upguard_monthly_risk_report：月次リスクレポートを生成します。
• upguard_risk_mitigation_planning：リスク軽減計画を作成します。
• upguard_executive_risk_summary：経営層向けのリスク概要を作成します。

📊 コンプライアンスとレポート

• upguard_compliance_reporting_suite - コンプライアンスレポートの自動生成

🌐 アセット管理

• upguard_domain_lifecycle_management - ドメインのライフサイクル全体を管理するワークフロー
• upguard_bulk_asset_management - 大規模なアセット管理操作
• upguard_network_security_assessment - 包括的なネットワークセキュリティ分析
• upguard_check_domain_risks：特定のドメインのリスクを確認します。
• upguard_review_typosquatting_for_domain：ドメインのタイポスクワッティング情報を確認します。
• upguard_manage_bulk_hostnames_simple：ホスト名を一括で追加・削除するシンプルなワークフローです。

🪝 運用と監視

• upguard_setup_comprehensive_alerting - アラート機能を包括的に設定します。
• upguard_security_dashboard_setup - 役割ベースのセキュリティダッシュボードを設定します。

🏢 ベンダーと組織に関するプロンプト

• upguard_get_my_organization_risks：組織のすべてのリスクの一覧を取得します。
• upguard_monitor_new_vendor：新しいベンダーの監視を開始します。
• upguard_assess_vendor_risks：特定のベンダーのリスクを評価します。
• upguard_get_my_organization_details：組織の詳細情報を取得します。
• upguard_list_vendors_with_critical_risks：重大なリスクを抱えるすべてのベンダーを一覧表示します。
• upguard_full_vendor_risk_profile：ベンダーのリスクプロファイル全体を取得します。
• upguard_monitor_new_vendor_and_send_questionnaire：新しいベンダーの監視を開始し、質問票を送信します。

🚨 侵害とレポートに関するプロンプト

• upguard_investigate_breaches：特定のドメインの侵害を調査します。
• upguard_generate_report：レポートを生成します。
• upguard_investigate_identity_breach_for_domain：ドメインのID侵害を調査します。
• upguard_generate_vendor_report_and_track：ベンダーレポートを生成し、その状況を追跡します。

メリット：

• 複雑なセキュリティワークフローを段階的に案内します
• 複数の API エンドポイントを組み合わせて、複数のツールを連携させます
• 関係者（CISO、アナリスト、コンプライアンス担当者）ごとの役割ベースのワークフローを提供します
• 組み込みのセキュリティ推奨事項により、ベストプラクティスを取り入れています

📖 詳細なドキュメントと例については、ENHANCED_PROMPTS.md をご覧ください。

クイックスタート

前提条件

• Node.js 18+
• npm または yarn
• UpGuard CyberRisk API の認証情報

インストール

git clone https://github.com/leroylim/upguard-cyberrisk-mcp-server-nodejs.git
cd upguard-cyberrisk-mcp-server-nodejs
npm install

設定

UpGuard の認証情報を記載した .env ファイルを作成します。

UPGUARD_API_KEY=your_api_key_here

サーバーの実行

npm start

MCP の設定

このサーバーを Claude Desktop またはその他の MCP 対応クライアントで使用するには、MCP 設定ファイルに追加する必要があります。

Claude Desktop の場合（Windows/Mac/Linux）

次の設定を claude_desktop_config.json ファイルに追加します。

Windows: %APPDATA%\Claude\claude_desktop_config.json Mac: ~/Library/Application Support/Claude/claude_desktop_config.json Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "upguard-mcp": {
      "command": "node",
      "args": [
        "/path/to/your/upguard-cyberrisk-mcp-server/src/index.js"
      ],
      "env": {
        "UPGUARD_API_KEY": "your_upguard_api_key_here"
      }
    }
  }
}

Cursor IDE の場合

Cursor の設定ディレクトリにある mcp.json ファイルに、次の設定を追加します。

Windows: %APPDATA%\Cursor\User\mcp.json Mac: ~/Library/Application Support/Cursor/User/mcp.json
Linux: ~/.config/Cursor/User/mcp.json

{
  "mcpServers": {
    "upguard-mcp": {
      "command": "node",
      "args": [
        "/path/to/your/upguard-cyberrisk-mcp-server/src/index.js"
      ],
      "env": {
        "UPGUARD_API_KEY": "your_upguard_api_key_here"
      }
    }
  }
}

設定に関する注意事項

• パスを置き換える：/path/to/your/upguard-cyberrisk-mcp-server/src/index.js をインストール先の実際のパスに置き換えます
• API キーを置き換える：your_upguard_api_key_here を実際の UpGuard API キーに置き換えます
• サーバー名：upguard-mcp は任意の名前に変更できます

UpGuard API キーの取得

前提条件：

• 管理者アクセス権のある UpGuard アカウント（API トークンにアクセスできるのは管理者のみです）
• cyber-risk.upguard.com で UpGuard プラットフォームにアクセスできること

手順：

1. https://cyber-risk.upguard.com で UpGuard アカウントにログインします
2. UpGuard の右上にある 設定アイコンをクリックします
3. 設定メニューで API タブに移動します
4. API キーを作成または管理します。
   • 既存の API キーはすべてここに表示されます
   • **「Create new API key」**をクリックして、新しいキーを生成します
   • 必要に応じて、このタブから既存のキーを削除することもできます
5. API キーをコピーします。これは英数字の文字列です
6. キーを MCP 設定ファイルに貼り付けます

API キーのテスト（任意）： curl でテストして、API キーが機能することを確認できます。

curl -H "Authorization: YOUR_API_KEY" "https://cyber-risk.upguard.com/api/public/vendors"

セキュリティに関する注意事項：

• API キーを安全に保管し、公開しないでください
• API キーを作成および管理できるのは管理者のみです
• 複数の API キーを作成し、必要に応じて削除できます
• API のベース URL は https://cyber-risk.upguard.com/api/public です

詳細については、UpGuard 公式 API 認証ガイドをご覧ください。

再起動が必要です

MCP 設定を更新した後、変更を反映するには Claude Desktop または IDE を再起動してください。

ドキュメントシステム

このプロジェクトには、ソースコードから複数の形式のドキュメントを生成する、包括的なドキュメント生成システムが用意されています。

📚 利用可能なドキュメント形式

• 📊 インタラクティブなドキュメントハブ - 統計情報を備えた一元的なナビゲーション
• 🚀 Swagger UI - エンドポイントのテストに使えるインタラクティブな API エクスプローラー
• 📚 Redoc - 洗練されたプロフェッショナルな API ドキュメント
• 📖 Markdown - 例を含む、人が読みやすいドキュメント
• 🔧 OpenAPI 仕様 - ツールで使用できる機械可読な API 仕様

🛠️ ドキュメントコマンド

# Generate complete documentation pipeline
npm run docs:full

# Individual generation steps
npm run docs:extract      # Extract tools from source code
npm run docs:generate     # Generate OpenAPI and Markdown
npm run docs:html         # Generate HTML documentation
npm run docs:test         # Validate generated documentation

# Utility commands
npm run docs:clean        # Clean generated files
npm run docs:build        # Generate with mock fallback

📊 ドキュメント統計

• 67 個の API ツールを 13 カテゴリーにわたって文書化
• 22 個のスキーマ定義に Zod 検証を使用
• スキーマを備えたツールは 54 個（スキーマカバー率 80%）
• 195KB の OpenAPI 仕様に包括的な例を収録
• 37KB の Markdown ドキュメントに認証ガイドを収録

🌐 ドキュメントの表示

npm run docs:full の実行後、次のファイルをブラウザーで開きます。

• ドキュメントハブ：docs/generated/index.html
• Swagger UI：docs/generated/swagger.html
• Redoc：docs/generated/redoc.html
• Markdown：docs/generated/API.md
• OpenAPI 仕様：docs/generated/openapi.json

API カテゴリー

🛡️ リスク管理（10 ツール）

• 利用可能なリスクとリスクの詳細を取得
• アカウントとベンダーのリスクを監視
• リスクのフィルタリングと分類

🏢 ベンダー管理（16 ツール）

• ベンダーのセキュリティを監視、管理
• ベンダーのリスク評価
• ベンダーの一括操作

🌐 ドメイン管理（9 ツール）

• ドメインの監視と分析
• サブドメインの検出
• ドメインのリスク評価

🔍 IP 管理（5 ツール）

• IP アドレスの監視
• ネットワークセキュリティ分析
• IP リスクの評価

📊 レポート生成（7 ツール）

• カスタムセキュリティレポート
• レポートの自動スケジュール設定
• レポートデータのエクスポート

🚨 データ侵害の監視（2 ツール）

• データ侵害の検出
• 侵害の影響分析

⚡ 一括操作（6 ツール）

• バッチ処理機能
• ベンダーの一括更新
• データの一括操作

🔗 Webhook 管理（5 ツール）

• イベント通知の設定
• Webhook の設定
• リアルタイムアラート

📋 その他のカテゴリ

• アンケート管理（1 ツール）
• タイポスクワッティングの検出（1 ツール）
• ラベル管理（1 ツール）
• 通知管理（1 ツール）
• 一般（3 ツール）

開発

プロジェクト構成

├── src/
│   ├── tools/           # API tool implementations
│   │   ├── schemas/     # Zod schema definitions
│   │   ├── risks.js     # Risk management tools
│   │   ├── vendors.js   # Vendor management tools
│   │   └── ...          # Other tool categories
│   └── utils/
│       ├── doc-generator.js  # Documentation generator
│       └── logger.js         # Logging utility
├── scripts/
│   ├── extract-tools-direct.js  # Tool extraction
│   ├── generate-docs.js         # Documentation generation
│   ├── generate-html-docs.js    # HTML documentation
│   └── test-docs.js             # Documentation testing
├── docs/
│   ├── generated/       # Generated documentation
│   └── extracted-tools.json    # Extracted tool data
└── .github/workflows/
    └── docs.yml         # CI/CD documentation pipeline

新しいツールの追加

1. 適切なカテゴリファイルにツールの実装を作成します
2. src/tools/schemas/index.js にスキーマ定義を追加します
3. npm run docs:full を実行してドキュメントを更新します
4. npm run docs:test でテストします

スキーマの検証

すべてのツールで、入力検証に Zod スキーマを使用します。

const { z } = require('zod');
const { vendorHostname, labels } = require('./schemas');

// Tool with schema validation
server.tool('tool_name', 'Description', {
  hostname: vendorHostname,
  labels: labels.optional()
}, async (args) => {
  // Implementation
});

CI/CD 統合

このプロジェクトには、GitHub Actions によるドキュメントの自動生成が含まれています。

• トリガー：main/master へのプッシュ、ツールファイルの変更、手動実行
• 生成：すべてのドキュメント形式を自動生成
• デプロイ：インタラクティブなドキュメントを GitHub Pages にデプロイ
• 成果物：30 日間保持されるドキュメントファイル

テスト

# Run all tests
npm test

# Lint code
npm run lint
npm run lint:fix

# Test documentation
npm run docs:test

貢献

1. リポジトリをフォークします
2. フィーチャーブランチを作成します
3. 適切なスキーマとともにツールを追加します
4. npm run docs:full でドキュメントを更新します
5. npm run docs:test で変更をテストします
6. プルリクエストを送信します

ライセンス

MIT ライセンス - 詳細は LICENSE ファイルをご覧ください。

サポート

• GitHub Issues：バグの報告や機能のリクエスト
• ドキュメント：docs/generated/ に複数の形式で用意されています
• API リファレンス：インタラクティブな Swagger UI と Redoc のインターフェース

---

UpGuard CyberRisk MCP Server v1.4.0 | MIT ライセンス | ドキュメントを見る