Skip to main content

MCP server for Lumu Defender API integration with Claude Desktop

Project description

๐Ÿ›ก๏ธ Lumu MCP Server

Supercharge Claude Desktop with Lumu Defender security incident analysis

An MCP (Model Context Protocol) server that seamlessly integrates Claude Desktop with the Lumu Defender API, enabling AI-powered security incident analysis and management.

PyPI version Python 3.10+ License: MIT

โœจ Features

  • ๐Ÿ” Incident Retrieval: Get security incidents with advanced filtering
  • ๐ŸŽฏ Smart Analysis: AI-powered incident analysis through Claude
  • ๐Ÿ“Š Full Management: Mark as read, mute, unmute, and close incidents
  • ๐Ÿ–ฅ๏ธ Endpoint Insights: Analyze affected endpoints and network contacts
  • ๐Ÿ“ˆ Real-time Monitoring: Track incident updates and activity
  • ๐Ÿ” Secure Integration: Environment-based API key management
  • โšก Easy Setup: One-command installation with pip

๐Ÿš€ Quick Start

1. Install

pip install lumu-mcp-server

2. Configure Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "lumu-mcp-server": {
      "command": "lumu-mcp-server",
      "env": {
        "LUMU_DEFENDER_API_KEY": "your-api-key-here"
      }
    }
  }
}

3. Start Using

Ask Claude: "Get security incidents from Lumu Defender"

๐Ÿ’ก Need help finding your config file? See Configuration Locations below.

๐Ÿ”ง Configuration

Get Your Lumu Defender API Key

  1. Log in to your Lumu Defender account
  2. Navigate to Settings โ†’ API Keys
  3. Generate or copy your API key

Configuration File Locations

  • ๐ŸŽ macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • ๐ŸชŸ Windows: %APPDATA%\Claude\claude_desktop_config.json
  • ๐Ÿง Linux: ~/.config/Claude/claude_desktop_config.json

Configuration Options

Standard Configuration (Recommended)

{
  "mcpServers": {
    "lumu-mcp-server": {
      "command": "lumu-mcp-server",
      "env": {
        "LUMU_DEFENDER_API_KEY": "your-api-key-here"
      }
    }
  }
}

Alternative Configuration

If the command isn't found, use the Python module directly:

{
  "mcpServers": {
    "lumu-mcp-server": {
      "command": "python",
      "args": ["-m", "lumu_mcp_server.server"],
      "env": {
        "LUMU_DEFENDER_API_KEY": "your-api-key-here"
      }
    }
  }
}

Activate the Integration

  1. Restart Claude Desktop completely
  2. Look for the ๐Ÿ”Œ MCP icon in Claude Desktop
  3. Test with: "Check the health of the lumu-mcp-server"

๐Ÿ’ฌ Usage Examples

Once configured, you can interact with Lumu Defender through natural language:

๐Ÿฉบ Health & Status

  • "Check the health of the lumu-mcp-server"
  • "Is the Lumu integration working?"

๐Ÿ” Incident Discovery

  • "Get security incidents from Lumu Defender"
  • "Show me open security incidents from the last 30 days"
  • "Find all C2C and Malware incidents"
  • "Get incidents with status 'open' or 'muted'"

๐Ÿ“‹ Incident Analysis

  • "Get details for incident [UUID]"
  • "Show me the full information about incident abc-123-def"
  • "Get the context for incident [UUID]"
  • "Show me related incidents and affected assets"

๐Ÿ“ Incident Management

  • "Add a comment to incident [UUID]: 'Investigating with network team'"
  • "Mark incident [UUID] as read"
  • "Mute incident [UUID] with comment 'False positive'"
  • "Close incident [UUID] with comment 'Threat resolved'"

๐Ÿ–ฅ๏ธ Network Analysis

  • "Get endpoints for incident [UUID]"
  • "Show me which endpoints were affected by this incident"
  • "Analyze the network impact of incident abc-123-def"

๐Ÿ“Š Real-time Monitoring

  • "Get incident updates from the last 10 minutes"
  • "Show me what happened in the last hour with incidents"
  • "Check for recent incident activity"

๐Ÿ”„ Advanced Workflows

  • "Get all open Malware incidents, then show details for the most recent one"
  • "Find critical incidents that are still open and summarize their impact"
  • "List all muted C2C incidents and help me decide which to unmute"
  • "Get incident endpoints and mark the incident as read when done"

Available Tools

1. health_check

Returns the server status and API key configuration status.

2. get_incidents

Retrieves security incidents with optional filters.

Parameters:

  • from_date (optional): Start date in ISO format (default: 7 days ago)
  • to_date (optional): End date in ISO format (default: now)
  • status (optional): Array of statuses ["open", "muted", "closed"]
  • adversary_types (optional): Array of types ["C2C", "Malware", "DGA", "Mining", "Spam", "Phishing"]
  • labels (optional): Array of label IDs

3. get_incident_details

Get detailed information about a specific security incident.

Parameters:

  • incident_id (required): The UUID of the incident

Returns: Detailed incident information including status, IOCs, recommended actions, and more.

4. get_incident_context

Get context information for a specific security incident.

Parameters:

  • incident_id (required): The UUID of the incident
  • hash_type (optional): Hash type for filtering context

Returns: Context including related incidents, affected assets, threat intelligence, and timeline.

5. comment_incident

Add a comment to a specific security incident.

Parameters:

  • incident_id (required): The UUID of the incident
  • comment (required): The comment text to add

Returns: Confirmation of the comment being added.

6. get_open_incidents

Retrieve only open security incidents.

Parameters:

  • adversary_types (optional): Array of types ["C2C", "Malware", "DGA", "Mining", "Spam", "Phishing"]
  • labels (optional): Array of label IDs

Returns: List of open incidents with filtering options.

7. get_muted_incidents

Retrieve only muted security incidents.

Parameters:

  • adversary_types (optional): Array of types ["C2C", "Malware", "DGA", "Mining", "Spam", "Phishing"]
  • labels (optional): Array of label IDs

Returns: List of muted incidents with filtering options.

8. get_closed_incidents

Retrieve only closed security incidents.

Parameters:

  • adversary_types (optional): Array of types ["C2C", "Malware", "DGA", "Mining", "Spam", "Phishing"]
  • labels (optional): Array of label IDs

Returns: List of closed incidents with filtering options.

9. get_incident_endpoints

Retrieve endpoints and contacts for a specific security incident.

Parameters:

  • incident_id (required): The UUID of the incident
  • endpoints (optional): Filter by specific endpoint IPs or names
  • labels (optional): Array of label IDs

Returns: Detailed endpoint and contact information for the incident.

10. mark_incident_as_read

Mark a security incident as read.

Parameters:

  • incident_id (required): The UUID of the incident to mark as read

Returns: Confirmation that the incident was marked as read.

11. mute_incident

Mute a security incident.

Parameters:

  • incident_id (required): The UUID of the incident to mute
  • comment (optional): Comment explaining why the incident was muted

Returns: Confirmation that the incident was muted.

12. unmute_incident

Unmute a security incident.

Parameters:

  • incident_id (required): The UUID of the incident to unmute
  • comment (optional): Comment explaining why the incident was unmuted

Returns: Confirmation that the incident was unmuted.

13. get_incident_updates

Get real-time updates on incident operations (alternative to WebSocket).

Parameters:

  • offset (optional): Starting offset for pagination (default: 0)
  • items (optional): Number of items to return, 1-100 (default: 50)
  • time (optional): Time window in minutes for updates (default: 5)

Returns: List of incident updates with timestamps in UTC (RFC 3339/ISO 8601 format).

14. close_incident

Close a security incident.

Parameters:

  • incident_id (required): The UUID of the incident to close
  • comment (optional): Comment explaining why the incident was closed

Returns: Confirmation that the incident was closed.

๐Ÿ”ง Troubleshooting

Server Not Appearing in Claude Desktop

  1. Check Claude Desktop logs: Help โ†’ Show Logs
  2. Verify installation: pip list | grep lumu-mcp-server
  3. Test command: Run lumu-mcp-server --help in terminal
  4. Restart Claude Desktop completely

API Key Issues

  • โœ… Ensure API key is correctly set in claude_desktop_config.json
  • โœ… Verify API key is valid in Lumu Defender portal
  • โœ… Check Claude Desktop logs for authentication errors
  • โœ… Test with: "Check the health of the lumu-mcp-server"

No Incidents Returned

  • ๐Ÿ“… Date Range: Try broader date ranges (e.g., last 30 days)
  • ๐Ÿ” Filters: Remove status/type filters to see all incidents
  • ๐Ÿ”‘ Permissions: Ensure API key has proper incident access
  • ๐Ÿ’ก Tip: Ask Claude "Get incidents from the last 30 days"

Connection Issues

  • ๐ŸŒ Network: Verify internet connection to defender.lumu.io
  • ๐Ÿ”’ Firewall: Ensure HTTPS traffic is allowed
  • ๐Ÿš€ Proxy: Configure proxy settings if needed

Need More Help?

๐Ÿ”’ Security & Privacy

  • ๐Ÿ” API keys stored in environment variables, never in code
  • ๐ŸŒ HTTPS encryption for all API communications
  • ๐Ÿšซ No data storage - all data fetched in real-time from Lumu
  • ๐Ÿ›ก๏ธ Error sanitization prevents sensitive information leakage
  • ๐Ÿ“ Audit trail through Lumu Defender's native logging

๐Ÿค Contributing

We welcome contributions! Please see our contribution guidelines:

Quick Development Setup

git clone https://github.com/jpyoda/lumu-mcp.git
cd lumu-mcp-server
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -e .

Adding New Features

  1. API Methods: Add to lumu_mcp_server/lumu_client.py
  2. Tool Registration: Update handle_list_tools() in server.py
  3. Handler Implementation: Add to handle_call_tool() in server.py
  4. Testing: Ensure functionality works with real API

๐Ÿ“„ License

MIT License - see LICENSE file for details.

๐Ÿ†˜ Support

Get Help

Project Stats

GitHub stars GitHub forks GitHub issues


Built with โค๏ธ for the cybersecurity community
Enhance your security operations with AI-powered incident analysis

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lumu_mcp_server-1.0.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lumu_mcp_server-1.0.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file lumu_mcp_server-1.0.0.tar.gz.

File metadata

  • Download URL: lumu_mcp_server-1.0.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.4

File hashes

Hashes for lumu_mcp_server-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9c9b57870f9474771445d68c8a1014eb8614fbd6f781491ec4c9cc632f4b7cda
MD5 b7cad1024bcc6007ce9bd7b97c663aad
BLAKE2b-256 722be2dd46760cf02bd8af4c2150e23a140a11f354fefd985c9aacb5ccf8b6b0

See more details on using hashes here.

File details

Details for the file lumu_mcp_server-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lumu_mcp_server-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e6309170a380b334963359267a725d7e9f1d714bbac125eda68775f7c8f41e45
MD5 a262bda184023526b812527cf0a42428
BLAKE2b-256 4d2cd2a8d8dd6179b54a4f686d559fe47eeffa63ce46019acac99508fd79fa8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page