使用说明
GCP MCP服务器
Google Cloud Platform(GCP)的模型上下文协议(MCP)服务器,使AI助手能够与GCP服务交互,特别侧重于日志分析和根本原因调查。
特性
- 云日志集成:查询和分析GCP云日志数据
- 实时日志流:用于即时分析的流日志
- 错误模式检测:识别常见的错误模式和异常
- 多项目支持:跨多个GCP项目工作
- 安全认证:使用GCP服务帐户凭据
- 根本原因分析:帮助快速发现RC的工具
支持的GCP服务
- 云日志:查询、筛选和分析日志
- 云监控:检索指标和警报(计划)
- 错误报告:访问错误统计和详细信息(计划)
- 云跟踪:分布式跟踪分析(计划中)
安装
⚡ 快速安装
git clone https://github.com/JayRajGoyal/gcp-mcp.git
cd gcp-mcp
./install.sh
Claude代码集成(一个命令!)
将此MCP服务器添加到Claude Code的最简单方法:
# If you have gcloud configured (recommended):
claude mcp add gcp-logs -e GOOGLE_APPLICATION_CREDENTIALS=/Users/$USER/.config/gcloud/application_default_credentials.json -- python3.11 -m gcp_mcp.cli --project YOUR_PROJECT_ID
或者使用服务帐户密钥文件:
claude mcp add gcp -- python3.11 -m gcp_mcp.cli --credentials /path/to/your/service-account-key.json
手动配置(备选)
将此添加到您的Claude代码配置中:
{
"mcpServers": {
"gcp": {
"command": "python3.11",
"args": ["-m", "gcp_mcp.cli", "--credentials", "/path/to/your/credentials.json"],
"cwd": "/path/to/gcp-mcp"
}
}
}
先决条件
- Python 3.8或更高版本
- 启用了适当API的GCP项目
- 具有必要权限的服务帐户
手动设置
- 克隆存储库:
git clone https://github.com/JayRajGoyal/gcp-mcp.git
cd gcp-mcp
- 安装依赖项:
pip install -r requirements.txt
- 使用您的凭据运行:
python -m gcp_mcp.cli --credentials /path/to/your/credentials.json
用法
启动服务器
python -m gcp_mcp.server
可用工具
日志查询
使用高级过滤器查询GCP云日志:
query_logs(project_id, filter, limit, time_range)
日志分析
分析日志中的模式和异常:
analyze_logs(project_id, service_name, time_range)
错误调查
查找并分析错误模式:
investigate_errors(project_id, service_name, time_range)
配置
创建一个 config.json 文件:
{
"default_project": "your-gcp-project-id",
"log_retention_days": 30,
"max_results": 1000,
"excluded_log_names": [
"projects/your-project/logs/cloudaudit.googleapis.com%2Fdata_access"
]
}
认证
服务器支持多种身份验证方法:
- 服务帐户密钥文件:设置
GOOGLE_APPLICATION_CREDENTIALS - 应用程序默认凭据:适用于GCE、Cloud Shell等。
- 用户凭据:通过
gcloud auth application-default login
所需的GCP权限
您的服务帐户需要以下IAM角色:
roles/logging.viewer-读取云日志的访问权限roles/monitoring.viewer-读取云监控权限(可选)roles/errorreporting.viewer-读取错误报告(可选)
发展
运行测试
pytest tests/
代码格式化
black gcp_mcp/
isort gcp_mcp/
类型检查
mypy gcp_mcp/
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 添加测试
- 运行测试套件
- 提交拉取请求
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
安全
- 切勿将服务帐户密钥提交到存储库
- 使用环境变量进行敏感配置
- 遵循GCP安全最佳实践
- 通过电子邮件报告安全漏洞
支持
- 为错误报告或功能请求创建问题
- 在创建新问题之前检查现有问题
- 提供详细信息,包括日志和配置
路线图
- []云监控集成
- []错误报告工具
- []云跟踪分析
- []BigQuery日志导出支持
- []警报和通知工具
- []仪表板生成
- []成本分析工具
