article
README
🚀 @genm/switchbot-mcp
本项目是一个提供SwitchBot设备控制能力的模型上下文协议(MCP)服务器,借助它,AI助手能够轻松控制SwitchBot设备。
🚀 快速开始
本项目可助力AI助手实现对SwitchBot设备的控制。你可以通过Smithery自动安装,也能手动完成安装,之后按步骤完成相关配置,即可开启设备控制之旅。
✨ 主要特性
- 设备管理:可列出设备、获取设备状态、控制设备开关以及调整设备设置。
- 场景控制:支持列出场景和执行场景。
- 状态监控:能够对设备状态进行监控。
- 传感器信息获取:可获取温度、湿度、明亮度和运动感应等传感器信息。
📦 安装指南
使用Smithery安装
通过Smithery可自动安装SwitchBot MCP服务器以Claude Desktop运行,命令如下:
npx -y @smithery/cli install @genm/switchbot-mcp --client claude
手动安装
npm install @genm/switchbot-mcp
📚 详细文档
设置
1. SwitchBot API配置
- 安装SwitchBot应用程序。
- 创建账户并登录。
- 进入个人资料 > 设置 > 开发者选项。
- 获取您的令牌和密钥。
2. MCP服务器配置
将以下内容添加到claude_desktop_config.json:
{
"mcpServers": {
"switchbot": {
"command": "node",
"args": ["path/to/switchbot-mcp/build/index.js"],
"env": {
"SWITCHBOT_TOKEN": "your_token",
"SWITCHBOT_SECRET": "your_secret"
}
}
}
}
3. 环境变量
SWITCHBOT_TOKEN=your_token
SWITCHBOT_SECRET=your_secret
支持的设备
| 设备类型 | 具体设备示例 | | ---- | ---- | | 插座 | 客厅地灯、办公室电脑电源 | | 机器人 | 厨房咖啡机、客厅空气净化器 | | 窗帘 | 卧室窗饰、书房遮光窗帘 | | 空调 | 客厅空调、卧室空调 | | 加湿器 | 卧室加湿器、书房加湿器 | | 灯具 | 厨房主灯、卧室夜灯 | | 遥控设备 | 客厅电视、书房风扇 |
设备命名示例
为了便于AI助手理解,建议为设备提供描述性名称。例如:
- “卧室窗帘”而不是“窗帘”
- “客厅空调”而不是“空调”
这种命名习惯有助于AI助手识别设备的位置和用途。
支持的操作
设备管理
- 列出设备
- 获取设备状态
- 控制设备开关
- 调整设备设置
场景管理
- 列出场景
- 执行场景
传感器信息
- 温度
- 湿度
- 明亮度
- 运动感应
开发
# 构建
npm run build
# 开发模式(TypeScript)
npm run dev
# 启动
npm start
故障排除
设备无响应
- 确认设备在蓝牙范围内。
- 检查设备电池状态。
- 确认SwitchBot中继器连接状态。
认证错误
- 检查令牌和密钥的有效期。
- 重新生成令牌和密钥。
- 更新环境变量。
📄 许可证
本项目采用ISC许可证。
微信扫一扫