项目简介
GCP AuditMate MCP 服务器是一个专为 Google Cloud Platform (GCP) 设计的自助式审计工具后端,它通过 Model Completion Protocol (MCP) 与 LLM (大型语言模型) 客户端通信。用户可以通过支持 MCP 协议的 LLM 客户端(如 Claude Desktop)触发对 GCP 资源的自动化审计,生成详细的报告,从而提高云环境的管理和合规效率。
主要功能点
- GCP 资源审计: 自动扫描并审计 GCP 项目中的关键资源,包括 IAM 权限、BYOK (自携金钥) 配置和防火墙规则。
- 自动化报告生成: 将审计结果整理并生成标准的 Excel 格式报告。
- LLM 客户端集成: 作为 MCP 服务器,与支持 MCP 协议的 LLM 客户端无缝集成,允许用户通过自然语言指令触发审计任务。
- 易于使用: 结合 LLM 客户端的交互能力和后端自动化,简化审计流程,即使非技术人员也能轻松操作。
安装步骤
本项目是一个标准的 Spring Boot 应用。在运行之前,您需要:
- 确保您的系统安装了 Java Development Kit (JDK) 17 或更高版本。
- 获取项目的可执行 JAR 文件。通常,您可以从项目的发布页面下载,或者如果您是开发者,可以克隆仓库并在本地构建项目(使用 Maven 或 Gradle)。
- 配置 GCP 认证: 本工具需要访问您的 GCP 项目。最推荐的方式是使用 GCP Application Default Credentials (ADC)。请确保您已安装 Google Cloud SDK,并在终端中执行以下命令进行认证:
如果是在无浏览器环境中运行,可以使用:gcloud auth application-default login
请确保用于认证的账号具有足够权限(例如 'roles/owner' 或至少是 'roles/iam.viewer', 'roles/cloudkms.viewer', 'roles/compute.networkViewer' 等相关权限)来读取目标 GCP 项目的 IAM、KMS 和防火墙信息。gcloud auth application-default login --no-browser
服务器配置
MCP 客户端需要知道如何启动并连接到 MCP 服务器。您需要在 MCP 客户端中配置本服务器的信息。典型的 MCP 服务器配置是一个 JSON 对象,包含服务器名称 ('name')、启动服务器进程的命令 ('command') 及其参数 ('args')。
请根据您实际下载或构建的可执行 JAR 文件路径,在您的 MCP 客户端中配置以下信息。假设您的 JAR 文件名为 'gcp-auditmate-mcp-server.jar':
{ "name": "GCP AuditMate", "command": "java", "args": [ "-jar", "<您的 JAR 文件完整路径>/gcp-auditmate-mcp-server.jar" ] }
- '"name"': 在 MCP 客户端中显示的服务器名称,您可以自定义一个易于识别的名称,例如 "GCP AuditMate" 或 "我的GCP审计工具"。
- '"command"': 启动服务器进程的命令。对于 Java 应用,通常是 '"java"'。
- '"args"': 传递给命令的参数列表。
- '"-jar"': Java 命令的标准参数,用于指定运行一个 JAR 文件。
- '"<您的 JAR 文件完整路径>/gcp-auditmate-mcp-server.jar"': 这是您需要根据实际情况替换的部分。请填写您下载或构建的 'gcp-auditmate-mcp-server.jar' 文件的完整文件系统路径。
完成配置后,MCP 客户端将能够通过运行此命令来启动服务器进程,并通过标准输入/输出 (Stdio) 或其他支持的协议与之通信。
基本使用方法
- 启动 MCP 客户端: 运行您的 MCP 客户端应用程序(例如 Claude Desktop)。
- 配置并连接服务器: 在客户端的设置或扩展/工具管理界面中,添加上述配置信息,并确保客户端成功连接到 "GCP AuditMate" MCP 服务器。客户端可能会显示服务器已加载的工具列表(应包含名为 'performAudit' 的工具)。
- 通过 LLM 交互: 在与 LLM 的对话中,通过自然语言描述您想进行的 GCP 审计任务。例如:
- "请帮我审计一下我的 GCP 项目 'my-project-id' 的 IAM 权限和防火墙规则,生成 2024 年上半年的报告。"
- "对项目 'another-project' 进行 BYOK 审计,报告年份 2025,季度 H1。"
- 确保您的指令清晰包含 LLM 调用工具所需的参数信息:'projectId' (GCP 项目 ID)、'year' (年份,如 2024) 和 'quarter' (季度,H1 或 H2)。
- 获取报告: LLM 客户端会识别您的意图,调用 'performAudit' 工具。工具执行完成后,会在对话中返回审计结果,包括生成的 Excel 报告文件的路径或 Base64 编码数据。您可以通过客户端提供的链接或方式打开或下载报告文件。
如果遇到权限问题,请参考安装步骤中的 GCP 认证说明,确保认证凭证有效且具有足够权限访问目标 GCP 项目。
信息
分类
开发者工具