README
🚀 这不是准备好的 MCP 服务器
这是一个全面的模型上下文协议 (MCP) 服务器实现,专为谷歌云平台 (GCP) 服务设计。借助它,AI 助手能够通过标准化接口与 GCP 资源进行交互和管理,极大地提升了资源管理的效率和便捷性。
🚀 快速开始
先决条件
- 安装 Python 和 pip。
- 下载并安装 Google Cloud SDK。
安装步骤
- 克隆仓库:
git clone https://github.com/yourusername/gcp-mcp-server.git cd gcp-mcp-server - 安装依赖项:
pip install -r requirements.txt
环境配置
将以下内容添加到 config.json 文件中:
{
"GOOGLE_APPLICATION_CREDENTIALS": "path/to/service-account-key.json",
"GCP_PROJECT_ID": "your-gcp-project-id",
"GCP_LOCATION": "us-east1"
}
启动服务器
python main.py
✨ 主要特性
GCP MCP 服务器赋予 AI 助手强大的能力,使其能够对 GCP 资源进行全面的查询、管理和操作。支持的服务丰富多样,涵盖了资产注册表、大查询、构建、云函数、计算、日志记录、监控、运行和存储等多个方面:
- Artifact Registry:资产注册表
- BigQuery:大查询
- Build:构建
- Cloud Functions:云函数
- Compute:计算
- Logging:日志记录
- Monitoring:监控
- Run:运行
- Storage:存储
🔧 技术细节
架构组成
项目的架构由以下关键部分构成:
- 核心功能:包含日志记录、异常处理和配置管理,为整个项目的稳定运行提供基础支撑。
- 服务模块:每个 GCP 服务对应独立的模块,保证了系统的可扩展性和维护性。
- 客户端实例管理:负责创建和销毁 GCP 客户端实例,有效管理资源的使用。
📦 安装指南
Docker 部署
创建 Dockerfile:
FROM python:3.9-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY . .
CMD ["python", "main.py"]
构建并运行镜像:
docker build -t gcp-mcp-server .
docker run -it --rm -v $(pwd)/config.json:/app/config.json gcp-mcp-server
配置选项
可以在 config.json 中设置以下参数:
| 属性 | 详情 |
|------|------|
| GOOGLE_APPLICATION_CREDENTIALS | GCP 服务账号密钥路径 |
| GCP_PROJECT_ID | GCP 项目 ID |
| GCP_LOCATION | GCP 区域,默认为 "us-east1" |
💻 使用示例
使用说明
使用本服务器的步骤如下:
- 将 GCP 服务账号密钥文件命名为
service-account.json并放置在当前目录。 - 安装 MCP 包:
pip install "mcp[cli]" - 安装所需的 GCP 包:
pip install google-cloud-run - 启动服务器:
mcp dev gcp_cloudrun_server.py
或者在 Claude Desktop 中安装:
mcp install gcp_cloudrun_server.py --name "GCP Cloud Run Manager"
MCP 服务器配置
将以下配置添加到您的 MCP 配置文件中,以启用 GCP 云工具:
"mcpServers": {
"GCP 云工具": {
"command": "uv",
"args": [
"run",
"--with",
"google-cloud-artifact-registry>=1.10.0",
"--with",
"google-cloud-bigquery>=3.27.0",
"--with",
"google-cloud-build>=1.6.0",
"--with",
"google-cloud-functions>=2.24.0",
"--with",
"google-cloud-storage>=1.38.0"
]
}
}
📚 详细文档
开发新 GCP 服务
要开发新的 GCP 服务模块,请参考 services/ 目录中的现有实现,并遵循以下步骤:
- 创建新服务模块。
- 实现接口方法。
- 注册服务提供者。
- 更新文档和示例。
安全注意事项
- 凭据管理:使用环境变量或加密存储来管理 GCP 凭据,确保凭据的安全性。
- 访问控制:限制对 MCP 服务器的访问,防止未授权操作,保障系统的安全性。
- 审计日志:记录所有 API 调用,便于后续审核,方便进行问题排查和安全审计。
贡献指南
- Fork 仓库。
- 创建功能分支。
- 提交更改。
- Push 到远程仓库。
- 提交 Pull Request。
📄 许可证
本项目遵循 MIT 许可证。请查看 LICENSE 文件以获取详细信息。
👏 致谢
感谢以下团队和项目的贡献:
- 谷歌云平台团队,提供了丰富的 API。
- 模型上下文协议团队,制定了标准化交互方式。
感谢使用 GCP MCP 服务器!如需帮助或反馈,请联系维护团队。
微信扫一扫