Illumio MCP Server 使用说明

项目简介

Illumio MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器，旨在为大型语言模型 (LLM) 客户端提供与 Illumio Policy Compute Engine (PCE) 交互的能力。通过该服务器，用户可以使用对话式 AI 以程序化的方式管理 Illumio 环境中的工作负载、标签、流量策略等，并进行安全分析。

主要功能点

工作负载管理: 创建、更新、删除 Illumio PCE 中的工作负载。
标签操作: 创建、更新、删除标签，用于组织和分类工作负载。
流量分析: 获取详细和汇总的流量数据，支持多维度过滤，用于安全分析和策略优化。
策略管理: 检索和管理 Illumio PCE 中的规则集和 IP 列表。
连接性测试: 验证与 Illumio PCE 的连接和凭据有效性。
事件管理: 获取 Illumio PCE 中发生的事件，用于监控和审计。
Prompt 模板: 内置多种 Prompt 模板，如环绕应用防护 (ringfence-application) 和应用流量分析 (analyze-application-traffic)，简化复杂操作。

安装步骤

克隆仓库

在你的终端中执行以下命令克隆仓库到本地：

git clone https://github.com/alexgoller/illumio-mcp-server
cd illumio-mcp-server

安装依赖

使用 pip 安装项目依赖：

pip install -r requirements.txt

服务器配置

要将 Illumio MCP Server 集成到 MCP 客户端（例如 Claude Desktop），你需要配置客户端以连接到该服务器。以下是 Claude Desktop 客户端的配置示例，你需要将此配置添加到 Claude Desktop 的配置文件 'claude_desktop_config.json' 的 'custom_settings' 部分。

配置文件路径：

MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容 (JSON 格式):

"mcpServers": {
    "illumio-mcp": {  // MCP 服务器的名称，在客户端中用于标识
      "command": "uv", // 启动服务器的命令，这里使用 uv (建议使用 uv 运行 Python 应用)
      "args": [ // 启动命令的参数列表
        "--directory",  // 指定工作目录
        "/path/to/illumio-mcp-server", // 替换为你的 illumio-mcp-server 仓库的本地路径
        "run", // uv 的 run 命令，用于运行 Python 模块
        "src/illumio_mcp" // 指定要运行的 Python 模块路径，这里指向 server.py 所在的目录
      ],
      "env": { // 环境变量配置
        "PCE_HOST": "your-pce-host", // 替换为你的 Illumio PCE 主机地址
        "PCE_PORT": "your-pce-port", // 替换为你的 Illumio PCE 端口号
        "PCE_ORG_ID": "1", // 替换为你的 Illumio 组织 ID
        "API_KEY": "your-api-key", // 替换为你的 Illumio API 密钥
        "API_SECRET": "your-api-secret" // 替换为你的 Illumio API 密钥的 secret
      }
    }
  }

配置参数说明:

'"illumio-mcp"': 服务器名称，可以自定义，客户端通过此名称引用服务器。
'"command": "uv"': 指定用于启动服务器的命令。这里推荐使用 'uv'，如果未安装 'uv'，可能需要替换为 'python3' 或 'python'，并相应调整 'args'。
'"args"': 命令参数列表。
- '"--directory", "/path/to/illumio-mcp-server"': 务必替换 '/path/to/illumio-mcp-server' 为你本地仓库的绝对路径。 这确保服务器在正确的目录下启动。
- '"run", "src/illumio_mcp"': 指示 'uv' 运行 'src/illumio_mcp' 目录下的模块，实际会执行 'src/illumio_mcp/main.py' 或 'src/illumio_mcp/server.py' (如果 'main.py' 导入了 'server.py' 中的 'main' 函数)。
'"env"': 环境变量配置。
- '"PCE_HOST"', '"PCE_PORT"', '"PCE_ORG_ID"', '"API_KEY"', '"API_SECRET"': 这些是连接 Illumio PCE 实例所必需的凭据信息，请务必替换为你的实际值。 从你的 Illumio PCE 实例获取这些信息。

Docker 部署 (可选):

仓库也提供了 Docker 部署方式，如果你选择使用 Docker，请参考仓库 README.md 中的 "Docker" 部分，配置 Claude Desktop 连接到 Docker 容器化的 Illumio MCP Server。 Docker 部署的配置方式与上述示例略有不同，请仔细阅读 README.md。

基本使用方法

启动 MCP 服务器: 配置完成后，MCP 服务器会在后台运行（如果使用 'uv' 或 Docker 部署）。
在 MCP 客户端中使用: 在支持 MCP 协议的客户端（如 Claude Desktop）中，你将看到名为 "illumio-mcp" 的集成。
选择 Prompt 或 Tool: 客户端会列出 Illumio MCP Server 提供的 Prompt 模板和 Tool 工具。
配置参数: 根据 Prompt 或 Tool 的要求，填写必要的参数，例如应用名称、环境名称、日期范围等。
执行操作: 点击 "Submit" 或类似按钮，客户端会将请求发送到 Illumio MCP Server，服务器会调用 Illumio PCE API 执行相应的操作，并将结果返回给客户端。
查看结果: 客户端会展示服务器返回的结果，例如流量分析报告、工作负载列表、操作状态等。

提示:

详细的 Prompt 使用示例和参数说明，请参考仓库 README.md 中的 "Available Prompts" 和 "How to use MCP prompts" 部分。
部分功能（如 Resources）可能尚未完全实现，请关注仓库的更新日志。
遇到问题，请在仓库的 Issue 页面提交问题。

关键词