使用说明
项目简介
CloudZero MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它允许大型语言模型 (LLM) 访问和分析 CloudZero 平台的云成本数据。通过此服务器,用户可以使用自然语言与 LLM 交互,查询云成本、分析趋势、并获取成本优化建议。
主要功能点
- 连接 CloudZero API: 服务器作为 LLM 和 CloudZero API 之间的桥梁,安全地访问您的 CloudZero 成本数据。
- 提供数据访问工具: 内置多个工具,允许 LLM 查询成本、维度、预算和洞察等关键 CloudZero 数据。
- 支持成本分析 Prompt: 提供预定义的 Prompt 模板,帮助 LLM 生成结构化的成本分析报告。
- 易于集成: 遵循 MCP 标准协议,可以方便地集成到支持 MCP 协议的 LLM 客户端,如 Claude Desktop。
安装步骤
-
安装 uv 包管理器: 按照 uv 官方文档 安装 uv。uv 是一个快速的 Python 包安装和运行工具。
# 请参考 uv 官方文档进行安装,此处省略具体安装命令,以避免平台差异 -
初始化项目并添加依赖: 使用 uv 初始化一个新的 Python 项目,并添加 'mcp[cli]' 依赖。
uv init uv add "mcp[cli]" -
设置 CloudZero API 密钥: 访问 CloudZero API Keys 获取您的 API 密钥,并将其设置为环境变量 'CLOUDZERO_API_KEY'。
export CLOUDZERO_API_KEY=YOUR_SECRET_KEY # 将 YOUR_SECRET_KEY 替换为您的实际密钥
服务器配置
要将 CloudZero MCP Server 集成到 MCP 客户端(例如 Claude Desktop),您需要配置客户端以连接到此服务器。以下是 Claude Desktop 'claude_desktop_config.json' 文件的配置示例,展示了如何配置一个名为 "CloudZero" 的服务器连接。
{ "CloudZero": { "command": "/Users/USERNAME/.local/bin/uv", // uv 命令的完整路径,请根据您的实际安装路径修改 "args": [ "run", "--with", "mcp[cli]", "mcp", "run", "/Users/USERNAME/workspace/open_source/cloudzero-mcp/server.py" // server.py 脚本的完整路径,请根据您的实际项目路径修改 ] } }
配置参数说明:
- command: MCP 服务器的启动命令。这里使用 'uv run' 来运行 Python 脚本。请确保 '/Users/USERNAME/.local/bin/uv' 是您 uv 命令的实际安装路径。您可以使用 'which uv' 命令查找 uv 的安装路径。
- args: 启动命令的参数列表。
- '"run"': uv 的 run 子命令,用于运行 Python 脚本。
- '"--with"' 和 '"mcp[cli]"': 指定运行环境包含 'mcp[cli]' 依赖。
- '"mcp"': 指定使用 mcp 命令行工具。
- '"run"': mcp 工具的 run 命令,用于启动 MCP 服务器。
- '"/Users/USERNAME/workspace/open_source/cloudzero-mcp/server.py"': MCP 服务器脚本 'server.py' 的完整路径。请将其替换为您 'server.py' 文件在您本地文件系统中的实际路径。
请注意: 您需要根据您的实际 uv 安装路径和 'server.py' 脚本路径修改 'command' 和 'args' 中的路径信息。
基本使用方法
- 启动 MCP 服务器: 按照上述 "服务器配置" 中的配置,在 MCP 客户端中添加并启用 "CloudZero" 服务器连接。
- 在 LLM 中提问: 在 LLM 客户端中,您可以开始向 LLM 提问关于 CloudZero 成本数据的问题。例如,您可以询问:
- "What tools are available?" (查看可用的工具)
- "Get billing costs for the last month." (使用 'get_costs' 工具查询上个月的成本)
- "Analyze costs for Q3 2023." (使用 'analyze_costs' Prompt 分析 2023 年第三季度的成本)
LLM 将会调用 CloudZero MCP Server 提供的工具和 Prompt 来响应您的查询,并返回 CloudZero 成本数据分析结果。
信息
分类
商业系统