🚀 MCP Cumulocity 服务器
MCP Cumulocity 服务器是一个基于 Python 的服务器，借助 MCP（模型控制协议）接口，提供 Cumulocity IoT 平台功能。它能够与 Cumulocity 的设备管理、测量和告警系统实现无缝交互。
🚀 快速开始
MCP Cumulocity 服务器可让你轻松与 Cumulocity IoT 平台进行交互。以下是使用该服务器的基本步骤：
- 确保满足先决条件。
- 按照安装步骤完成安装。
- 进行必要的配置。
- 若有需求，可将其集成到 Claude Desktop 中。
✨ 主要特性
设备管理
- 列出并筛选设备，方便你快速定位所需设备。
- 获取设备详细信息，深入了解设备状态。
- 查看设备层次结构（子设备），清晰掌握设备间的关系。
- 访问设备片段和属性，满足多样化的管理需求。
测量值
- 带时间过滤获取设备测量值，精准获取特定时间段的数据。
- 查看测量历史记录，便于进行数据分析和趋势预测。
告警
- 监控活动告警，及时发现设备异常。
- 根据严重性筛选告警，优先处理重要问题。
- 跟踪告警状态，确保问题得到妥善解决。
可用工具
- 设备管理：可列表设备、获取单个设备详细信息以及更新设备属性。
- 测量值：能查询历史测量数据、添加新测量值和删除指定时间范围内的测量值。
- 告警：支持创建新告警规则、查看活动告警和管理告警状态。
📦 安装指南
先决条件
- Python 3.13 或更高版本。
- 访问 Cumulocity IoT 平台实例。
- 配置所需的环境变量。
安装步骤
- 克隆仓库：
git clone
cd mcp-c8y
- 创建并激活虚拟环境：
python -m venv .venv
source .venv/bin/activate # 在 macOS/Linux 上
# 或者
.venv\Scripts\activate # 在 Windows 上
- 安装 uv（如果尚未安装）：
# 在 macOS/Linux 上
curl -LsSf https://astral.sh/uv/install.sh | sh
# 在 Windows PowerShell 上
irm https://astral.sh/uv/install.ps1 | iex
- 使用 uv 安装依赖项：
uv install
- 运行服务器：
uv run main:app
📚 详细文档
配置说明
将以下内容添加到项目根目录的 .env 文件中，以配置 Cumulocity 服务：
CUMULOCITY_API_KEY=your_api_key_here
CUMULOCITY_API_SECRET=your_api_secret_here
CUMULOCITY_BASE_URL=https://api.cumulocity.com
与 Claude Desktop 的集成
按照以下步骤将 MCP Cumulocity Server 集成到 Claude Desktop 中：
- 安装并运行 Claude Desktop。
- 在 Claude 中创建新项目，并指定 MCP Cumulocity Server 作为数据源。
- 配置项目的环境变量，包括 Cumulocity API 密钥和密钥。
- 使用 Claude 的工作流设计器集成服务器功能。
贡献指南
我们欢迎来自各方的贡献！以下是您如何为该项目做贡献的步骤：
- Fork 此仓库。
- 为功能或修复创建新分支。
- 按照以下最佳实践进行更改：
- 编写清晰、描述性的提交消息。
- 遵循现有的代码风格和惯例。
- 为新功能添加测试。
- 根据需要更新文档。
- 确保所有测试通过。
- 提交 Pull Request。
开发指南
- 使用有意义的变量名和函数命名。
- 为复杂逻辑添加注释。
- 为新功能编写单元测试。
- 保持提交专注且原子化。
- 遵循 PEP 8 样式指南。
- 为函数参数和返回值使用类型提示。
Pull Request 流程
- 如果需要，更新 README.md 以反映更改。
- 如有功能变更，请更新相关文档。
- 在获得至少一位维护者的批准后，Pull Request 将被合并。
如需更详细的贡献指南，请参考我们的 [CONTRIBUTING.md] 文件。
📄 许可证
MCP Cumulocity Server 的使用受 Apache License Version 2.0 的约束。
除非适用法律或书面协议另有要求，否则软件按“原样”分发，不附带任何形式的担保。