README
🚀 Coreflux MQTT MCP 服务器
Coreflux MQTT MCP 服务器是一个模型上下文协议(MCP)服务器,它能连接到 Coreflux MQTT 代理,为 Claude 及其他与 MCP 兼容的 AI 助手提供 Coreflux 和 MQTT 操作,极大地提升了相关操作的便利性和效率。
✨ 主要特性
- 🔗 可连接到 Coreflux MQTT 代理,建立稳定可靠的通信渠道。
- 🛠️ 提供所有 Coreflux 命令(模型、动作、规则、路由)的工具,满足多样化的操作需求。
- 🔍 能够发现并列出可用的操作,方便用户快速了解和使用。
- 📚 包含 LOT 语言文档作为资源,为开发者提供参考。
- 🤝 使用官方 MCP SDK 构建,实现与 Claude 的无缝集成。
- ⚙️ 带有独立设置助手进行配置,简化配置流程。
📦 安装指南
设置助手
服务器包含一个独立的设置助手,可单独运行。当遇到以下情况时可使用:
- 需要创建初始配置(.env 文件)。
- 想要更新现有配置。
- 经验连接问题需要重新配置时。
运行设置助手的命令如下:
python setup_assistant.py
设置助手可帮助您完成以下操作:
- 创建或更新.env 文件中的配置。
- 配置 MQTT 代理设置(主机、端口、凭据)。
- 设置 TLS 配置(如果需要)。
- 配置日志选项。
完成配置后,即可正常运行服务器。
💻 使用示例
将 Claude 连接到 MCP 服务器
使用 Claude 桌面配置
- 创建或编辑
~/Library/Application Support/Claude/claude_desktop_config.json(macOS/Linux)或%USERPROFILE%\AppData\Roaming\Claude\claude_desktop_config.json(Windows)。 - 添加以下配置(根据路径调整):
{ "mcpServers": { "coreflux": { "command": "python", "args": [ "/PATH/TO/server.py", "--mqtt-host", "localhost", "--mqtt-port", "1883", "--mqtt-user", "root", "--mqtt-password", "coreflux", "--mqtt-client-id", "claude-coreflux-client" ], "description": "Coreflux MQTT 代理控制", "icon": "🔄", "env": {} } } } - 重启 Claude 桌面。
命令行参数
服务器接受以下命令行参数。这些设置也可以通过 setup_assistant.py 中的.env 文件进行配置:
| 参数 | 描述 | 默认值 |
|------|------|-------|
| --mqtt-host | MQTT 代理地址 | localhost |
| --mqtt-port | MQTT 端口 | 1883 |
| --mqtt-user | MQTT 用户名 | - |
| --mqtt-password | MQTT 密码 | - |
| --mqtt-client-id | MQTT 客户端 ID | claude-mcp-client |
| --mqtt-use-tls | 启用 TLS 的 MQTT 连接 | false |
| --mqtt-ca-cert | CA 证书文件路径 | - |
| --mqtt-ca-cert | 客户端证书文件路径 | - |
| --mqtt-ca-key | 客户端密钥文件路径 | - |
可用工具
服务器支持以下命令:
基础用法
# 启动服务器
python server.py [--host HOST] [--port PORT]
高级用法
# 停止服务器
python server.py stop
# 重载配置
python server.py reload
📚 详细文档
调试和故障排除
验证配置
确保设置助手正确配置了 MQTT 代理,并且所有凭据有效。
检查日志
默认情况下,服务器输出到控制台。要启用文件日志记录,请修改配置文件中的 LOG_LEVEL 和 LOG_FILE 参数。
微信扫一扫