README
🚀 核心通量MQTT MCP服务器
核心通量MQTT MCP服务器是一个模型上下文协议(MCP)服务器,它能够连接到Coreflux MQTT代理,为Claude和其他与MCP兼容的AI助手提供Coreflux和MQTT操作,有效解决了AI助手与Coreflux及MQTT交互的问题,为相关应用提供了便捷的操作途径。
✨ 主要特性
- 🔌 连接到Coreflux MQTT代理,搭建稳定的数据传输通道。
- 🛠️ 提供所有Coreflux命令(模型、动作、规则、路由)的工具,满足多样化的操作需求。
- 🔍 发现并列出可用的动作,方便用户快速了解和使用。
- 📚 包含LOT语言文档作为资源,助力开发人员进行扩展和集成。
- 🤝 使用官方MCP SDK构建,与Claude无缝集成,实现高效协作。
- ⚙️ 独立设置助手进行配置,灵活满足不同场景的配置需求。
📦 安装指南
设置助手
服务器包含一个独立的设置助手,可以单独运行。当遇到以下情况时可使用:
- 需要创建初始配置(.env文件)。
- 更新现有配置。
- 经历连接问题需要重新配置时。
运行设置助手的命令如下:
python setup_assistant.py
设置助手能帮助您完成以下配置:
- 创建或更新
.env文件中的配置。 - 配置MQTT代理设置(主机、端口、凭据)。
- 设置TLS配置(如果需要)。
- 配置日志选项。
完成配置后,即可正常运行服务器。
💻 使用示例
将Claude连接到MCP服务器
使用Claude Desktop Config
- 创建或编辑
~/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 Desktop。
命令行参数
服务器接受以下命令行参数,这些设置也可以通过设置助手配置到.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 | 启用MQTT连接的TLS | false |
| --mqtt-ca-cert | CA证书文件路径 | - |
| --mqtt-client-cert | 客户端证书文件路径 | - |
| --mqtt-client-key | 客户端密钥文件路径 | - |
| --mqtt-log-level | 日志级别 | info |
通过MCP协议连接Claude
基础用法
- 安装依赖项:
- 确保安装了Python及其相关库(如
python-mqtt)。
- 确保安装了Python及其相关库(如
- 配置服务器:
- 使用设置助手或手动编辑
.env文件进行配置。
- 使用设置助手或手动编辑
- 启动服务器:
python server.py
- 在Claude中使用:
- 配置Claude以连接到MCP服务器,并指定要使用的模型和动作。
📚 详细文档
教程与文档
快速入门
- 安装并配置MCP服务器。
- 设置CLAude以使用MCP协议。
- 开始开发和部署自定义模型或服务。
详细指南
- 开发者文档:详细说明如何扩展和定制MCP服务器,以及如何与各种工具和服务集成。
- 用户指南:指导最终用户如何配置和使用MCP服务器。
Scan to join WeChat group