UpGuard CyberRisk MCP Server

A Model Context Protocol (MCP) server for integrating with UpGuard's CyberRisk API. This server provides comprehensive security risk assessment and management capabilities through a standardized interface.

Features

- 67 API Tools across 13 categories for comprehensive security management
- 25 Comprehensive Prompts including 8 advanced workflow prompts for complex operations
- Real-time Risk Assessment with vendor monitoring and breach detection
- Automated Documentation Generation with multiple output formats
- Interactive API Explorer with Swagger UI and Redoc interfaces
- Comprehensive Schema Validation with 22 Zod schema definitions
- CI/CD Integration with automated documentation deployment

Enhanced Prompts (New in v1.4.0)

The server now includes 25 comprehensive prompts (8 enhanced + 17 existing) that provide guided workflows for complex security operations:

🔴 Risk Management Prompts

- upguard_comprehensive_risk_assessment - Complete risk assessment workflows - upguard_risk_trend_analysis - Multi-period risk trend analysis - upguard_account_risk_dashboard: Create a risk dashboard for your account. - upguard_risk_trend_analysis_original: Analyze risk trends over a given period. - upguard_risk_severity_analysis: Analyze risks by severity. - upguard_critical_risk_prioritization: Prioritize critical risks. - upguard_risk_type_analysis: Analyze risks by type. - upguard_monthly_risk_report: Generate a monthly risk report. - upguard_risk_mitigation_planning: Create a risk mitigation plan. - upguard_executive_risk_summary: Create an executive-level risk summary.

📊 Compliance & Reporting

- upguard_compliance_reporting_suite - Automated compliance report generation

🌐 Asset Management

- upguard_domain_lifecycle_management - Complete domain lifecycle workflows - upguard_bulk_asset_management - Large-scale asset management operations - upguard_network_security_assessment - Comprehensive network security analysis - upguard_check_domain_risks: Check the risks for a specific domain. - upguard_review_typosquatting_for_domain: Review typosquatting information for a domain. - upguard_manage_bulk_hostnames_simple: A simple workflow to add and remove hostnames in bulk.

🪝 Operations & Monitoring

- upguard_setup_comprehensive_alerting - Complete alerting infrastructure setup - upguard_security_dashboard_setup - Role-based security dashboard configuration

🏢 Vendor & Organization Prompts

- upguard_get_my_organization_risks: Get a list of all risks for your organization. - upguard_monitor_new_vendor: Start monitoring a new vendor. - upguard_assess_vendor_risks: Perform a risk assessment for a specific vendor. - upguard_get_my_organization_details: Retrieve your organization's details. - upguard_list_vendors_with_critical_risks: List all vendors with critical risks. - upguard_full_vendor_risk_profile: Get a full risk profile for a vendor. - upguard_monitor_new_vendor_and_send_questionnaire: Monitor a new vendor and send them a questionnaire.

🚨 Breach & Report Prompts

- upguard_investigate_breaches: Investigate breaches for a specific domain. - upguard_generate_report: Generate a report. - upguard_investigate_identity_breach_for_domain: Investigate identity breaches for a domain. - upguard_generate_vendor_report_and_track: Generate a vendor report and track its status.

Benefits:
- Step-by-step guidance for complex security workflows
- Multi-tool orchestration combining multiple API endpoints
- Role-based workflows for different stakeholders (CISO, analysts, compliance)
- Best practices integration with built-in security recommendations

📖 See ENHANCED_PROMPTS.md for detailed documentation and examples.

Quick Start

Prerequisites

- Node.js 18+
- npm or yarn
- UpGuard CyberRisk API credentials

Installation

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

Configuration

Create a .env file with your UpGuard credentials:

UPGUARD_API_KEY=your_api_key_here

Running the Server

npm start

MCP Configuration

To use this server with Claude Desktop or other MCP-compatible clients, you need to add it to your MCP configuration file.

For Claude Desktop (Windows/Mac/Linux)

Add the following configuration to your claude_desktop_config.json file:

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"
      }
    }
  }
}

For Cursor IDE

Add the following configuration to your mcp.json file in your Cursor settings directory:

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"
      }
    }
  }
}

Configuration Notes

- Replace the path: Update /path/to/your/upguard-cyberrisk-mcp-server/src/index.js with the actual path to your installation
- Replace the API key: Update your_upguard_api_key_here with your actual UpGuard API key
- Server name: You can change upguard-mcp to any name you prefer

Getting Your UpGuard API Key

Prerequisites:
- An UpGuard account with administrator access (only administrators can access API tokens)
- Access to the UpGuard platform at cyber-risk.upguard.com

Step-by-step instructions:

1. Log in to your UpGuard account at https://cyber-risk.upguard.com
2. Click the Settings icon in UpGuard's top-right corner
3. Navigate to the API tab in the settings menu
4. Create or manage API keys:
- Any existing API keys will be listed here
- Click "Create new API key" to generate a new key
- You can also delete existing keys from this tab if needed
5. Copy your API key - it will be an alphanumeric string
6. Paste the key into your MCP configuration file

Testing your API key (optional):
You can verify your API key works by testing it with curl:

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

Security Notes:
- Keep your API key secure and don't share it publicly
- Only administrators can create and manage API keys
- You can create multiple API keys and delete them as needed
- The API base URL is: https://cyber-risk.upguard.com/api/public

For more detailed information, see the official UpGuard API authentication guide.

Restart Required

After updating your MCP configuration, restart Claude Desktop or your IDE for the changes to take effect.

Documentation System

This project features a comprehensive documentation generation system that creates multiple formats from the source code:

📚 Available Documentation Formats

- 📊 Interactive Documentation Hub - Central navigation with statistics
- 🚀 Swagger UI - Interactive API explorer for testing endpoints
- 📚 Redoc - Beautiful, professional API documentation
- 📖 Markdown - Human-readable documentation with examples
- 🔧 OpenAPI Specification - Machine-readable API spec for tooling

🛠️ Documentation Commands

```bash