article
README
🚀 Govee MCP 服务器
一个用于通过 Govee API 控制 Govee LED 设备的 MCP 服务器,借助此服务器,你可以轻松实现对 Govee LED 设备的各项控制操作。
🚀 快速开始
在使用 Govee MCP 服务器之前,你需要完成环境配置,然后进行安装操作。
✨ 主要特性
- MCP 服务器工具丰富:提供了如
turn_on_off、set_color、set_brightness等工具,可通过 Model Context Protocol 控制 Govee 设备。 - 命令行界面便捷:提供 CLI 工具,能够直接控制 Govee 设备,操作简单。
📦 安装指南
通过 Smithery 安装
使用 Smithery 自动安装 Govee MCP 服务器:
npx -y @smithery/cli install @mathd/govee_mcp_server --client claude
手动安装
# 使用 pip 安装
pip install .
# 开发模式(包含测试依赖)
pip install -e ".[test]"
环境配置
在项目根目录下创建一个 .env 文件,添加以下变量:
GOVEE_API_KEY=your_api_key_here
GOVEE_DEVICE_ID=your_device_id_here
GOVEE_SKU=your_device_sku_here
获取这些值的方法:
- 在 Govee 开发者控制台获取你的 API 密钥。
- 使用 Govee Home 应用查找你的设备 ID 和 SKU。
💻 使用示例
MCP 服务器
MCP 服务器提供了一些工具,用于通过 Model Context Protocol 控制 Govee 设备。 可用工具:
turn_on_off:开启或关闭 LEDset_color:使用 RGB 值设置 LED 颜色set_brightness:设置 LED 亮度
命令行界面 (CLI)
提供一个 CLI 工具,可以直接控制 Govee 设备:
# 开启或关闭设备
govee-cli power on
govee-cli power off
# 使用 RGB 值设置颜色(0 - 255)
govee-cli color 255 0 0 # 红色
govee-cli color 0 255 0 # 绿色
govee-cli color 0 0 255 # 蓝色
# 设置亮度(0 - 100)
govee-cli brightness 50
运行 govee-cli --help 查看完整的命令文档。
📚 详细文档
开发信息
运行测试
要运行测试套件:
# 安装测试依赖
pip install -e ".[test]"
# 运行所有测试
pytest tests/
# 运行特定的测试文件
pytest tests/test_server.py # 服务器测试(模拟 API 调用)
pytest tests/test_cli.py # CLI 测试(实际 API 调用)
# 以详细输出运行测试
pytest tests/ -v
⚠️ 重要提示
CLI 测试会实际调用你的 Govee 设备的真实 API,并实际控制它。在运行这些测试之前,请确保设备已通电并连接。
项目结构
.
├── src/govee_mcp_server/
│ ├── __init__.py
│ ├── server.py # MCP 服务器实现
│ └── cli.py # 命令行接口
├── tests/
│ ├── test_server.py # 服务器测试(模拟 API)
│ └── test_cli.py # CLI 测试(实际 API 调用)
└── pyproject.toml # 项目配置文件
测试覆盖率
- 服务器测试:验证 MCP 服务器的功能和性能。
- CLI 测试:测试命令行工具的实际操作和输出。 通过这些测试,可以确保 Govee MCP 服务器在各种场景下的稳定性和可靠性。
微信扫一扫