Alexgoller Illumio MCP Server

🚀 Illumio MCP Server

An MCP (Model Context Protocol) server that provides an interface to interact with the Illumio PCE (Policy Computation Engine). This server enables programmatic access to Illumio workload management, label operations, and traffic analysis.

🚀 Quick Start

The Illumio MCP Server is designed to interact with the Illumio PCE, providing programmatic access to various management and analysis features. Follow the steps below to get started.

✨ Features

Interact with Your PCE Using Conversational AI

• Create, update, and delete workloads.
• Create, update, and delete labels.
• Obtain traffic summaries and perform security analysis on them.
• Get the health status of the PCE.

📦 Installation

Prerequisites

• Python 3.8 or higher.
• Access to an Illumio PCE instance.
• Valid API credentials for the PCE.

Steps

1. Clone the repository:

git clone [Repository URL]
cd illumio-mcp

2. Install the dependencies:

pip install -r requirements.txt

💻 Usage Examples

Configuration

It is recommended to use the uv command to run the server, which makes it easier to pass environment variables and execute in the background.

Using uv and Claude Desktop

• macOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

Add the following content to the custom_settings section:

{
  "mcpServers": {
    "illumio-mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/alex.goller/git/illumio-mcp",
        "run",
        "illumio-mcp"
      ],
      "env": {
        "PCE_HOST": "Your PCE hostname",
        "PCE_PORT": "Your PCE port",
        "PCE_ORG_ID": "1", // Your organization ID
        "API_KEY": "api_key",
        "API_SECRET": "api_secret"
      }
    }
  }
}

Example Usage

uvicorn main:app --reload

After starting the server, access http://localhost:8000 to use the API.

📚 Documentation

Resources

Resources are not yet complete and will be studied in the future.

• illumio://workloads - Get workloads from the PCE.
• illumio://labels - Get all labels from the PCE.

Toolset

Workload Management

• get-workloads - Retrieve all workloads in the PCE.
• create-workload - Create an unmanaged workload with a specified name, IP address, and labels.
• update-workload - Update the attributes of an existing workload.
• delete-workload - Delete a workload from the PCE by name.

Label Operations

• create-label - Create a new label using key-value pairs.
• delete-label - Remove an existing label by key-value pair.
• get-labels - Retrieve all labels in the PCE.

Traffic Analysis

• get-traffic-flows - Get detailed traffic data with comprehensive filtering options:
  • Time range filtering.
  • Source/destination address filtering.
  • Service (port/protocol) filtering.
  • Policy decision filtering.
  • Workload and IP list query options.
  • Result limiting.
• get-traffic-flows-summary - Get summary information of traffic data with the same filtering capabilities as get-traffic-flows.

Policy Management

• get-rulesets - Get rulesets from the PCE with optional filtering:
  • Filter by name.
  • Filter by enabled status.

IP List Management

• get-iplists - Get IP lists from the PCE with optional filtering:
  • Filter by name.
  • Filter by description.
  • Filter by IP.

Troubleshooting

• diagnose - Perform troubleshooting steps, such as checking API connectivity and validating credentials.

⚠️ Error Handling

Common errors include invalid API credentials or network connection issues. Refer to the Troubleshooting Guide to resolve these problems.

🔒 Security Considerations

Ensure the security of your PCE API keys and avoid disclosure. It is recommended to update the keys regularly and implement strict access controls.

🤝 Contribution and Feedback

We welcome contributions and feedback from the community. Please submit issues or pull requests through the GitHub repository.

📄 License

This project is licensed under the MIT License. See the LICENSE file for specific terms.

📎 Appendix

Environment Variable Reference

• PCE_HOST - The host address of the PCE.
• PCE_PORT - The port used by the PCE, default is 443.
• PCE_ORG_ID - Your organization ID for authentication.
• API_KEY - The API key to access the PCE.
• API_SECRET - The corresponding API key secret.

By following the above steps, you can successfully configure and use the Illumio MCP Server. For further assistance, refer to the Official Documentation or contact the support team.