article
README
🚀 UCloud MCP 服务器
UCloud MCP 服务器是一个基于 MCP - Go 和 UCloud SDK 构建的云实例管理服务器,它支持通过 MCP 协议对 UCloud 实例进行高效管理,为用户提供便捷的实例管理体验。
✨ 主要特性
- 🔍 查询实例信息:可精准获取特定实例的详细内容。
- 📋 列出所有实例:查看账户下所有可用实例的完整列表。
- 📊 获取实例状态:实时掌握实例的当前运行状态。
- 📈 监控实例性能指标:提供如 CPU 使用率、磁盘 I/O 操作等全面的监控数据。
- 📡 支持 MCP 协议:通过标准输入/输出提供 MCP 协议支持。
- ⚙️ 配置文件支持:支持配置文件和环境变量两种配置方式。
📦 安装指南
依赖要求
- Go 1.23 或更高版本
- UCloud 账户和 API 凭证
配置方法
服务支持两种配置方式,配置优先级为:配置文件 > 环境变量。
1. 配置文件(推荐)
创建一个 config.json 文件:
{
"region": "cn-bj2",
"project_id": "your-project-id",
"public_key": "your-public-key",
"private_key": "your-private-key"
}
2. 环境变量
如果配置文件中未指定,服务将尝试从环境变量读取:
export UCLOUD_REGION="cn-bj2" # UCloud 区域
export UCLOUD_PROJECT_ID="your-project-id" # 项目 ID
export UCLOUD_PUBLIC_KEY="your-public-key" # API 公钥
export UCLOUD_PRIVATE_KEY="your-private-key" # API 私钥
安装与运行步骤
- 克隆仓库:
git clone https://github.com/renzheng.wang/ucloud-mcp-server.git
cd ucloud-mcp-server
- 安装依赖:
go mod download
- 构建服务:
go build -o ucloud-mcp-server
- 运行服务:
基础用法
./ucloud-mcp-server
使用自定义配置
./ucloud-mcp-server --config /path/to/config.json --port 8080
可用启动选项
--config:指定配置文件路径(默认:./config.json)--port:指定监听端口(默认:8080)
💻 使用示例
基础用法
# 直接运行服务,使用默认配置
./ucloud-mcp-server
高级用法
# 使用自定义配置文件和端口运行服务
./ucloud-mcp-server --config /path/to/config.json --port 8080
📚 详细文档
可用操作
实例信息
获取特定实例的详细信息,包括:
- 基本实例详情
- 配置信息
- 当前状态
- 资源分配
实例状态
实时监控任何实例的当前运行状态。
实例指标
访问全面的实例监控指标,包括:
- CPU 使用率
- 磁盘 I/O 操作
- 网络流量统计
- 系统性能数据
实例列表
查看您账户下所有可用实例的完整列表,包括其基本信息和当前状态。
监控指标
- 可能会有几分钟的延迟
- 定期检查监控指标以尽早发现潜在问题
Scan to join WeChat group