Corefluxmcpserver

🚀 Coreflux MQTT MCP Server

A Model Context Protocol (MCP) server that connects to the Coreflux MQTT broker and provides Coreflux and MQTT operations for Claude and other MCP-compatible AI assistants.

🚀 Quick Start

The Coreflux MQTT MCP Server is a powerful tool for integrating Coreflux and MQTT operations with AI assistants like Claude. It simplifies the process of interacting with the Coreflux MQTT broker and provides a range of useful features.

✨ Features

• Connect to the Coreflux MQTT broker.
• Provide tools for all Coreflux commands (models, actions, rules, routes).
• Discover and list available actions.
• Include LOT language documentation as a resource.
• Built with the official MCP SDK for seamless integration with Claude.
• Configure assistants independently.

📦 Installation

Setup Assistant

The server includes a standalone setup assistant that can be run separately. Use it when:

• You need to create an initial configuration (.env file).
• You want to update an existing configuration.
• You encounter connection issues and need to reconfigure.

Run the setup assistant:

python setup_assistant.py

The setup assistant helps you:

• Create or update the configuration in the .env file.
• Configure MQTT broker settings (host, port, credentials).
• Set up TLS configuration (if required).
• Configure logging options.

After completing the configuration, you can run the server normally.

💻 Usage Examples

Connecting Claude to the MCP Server

Using Claude Desktop Config

1. Create or edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS/Linux) or %USERPROFILE%\AppData\Roaming\Claude\claude_desktop_config.json (Windows).
2. Add the following configuration (adjust according to your path):

   {
     "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 broker control",
         "icon": "🔄",
         "env": {}
       }
     }
   }
   

3. Restart Claude Desktop.

Command Line Arguments

The server accepts the following command-line arguments. These settings can also be configured in the .env file using the setup assistant:

Connecting via MCP Protocol

1. Install Dependencies:

   • Ensure Python and its related libraries (e.g., python-mqtt) are installed.

2. Configure the Server:

   • Use the setup assistant or manually edit the .env file for configuration.

3. Start the Server:

   python server.py
   

4. Use in Claude:

   • Configure Claude to connect to the MCP server and specify the models and actions to use.

📚 Documentation

Quick Start Guide

1. Install and configure the MCP server.
2. Set up Claude to use the MCP protocol.
3. Start developing and deploying custom models or services.

Detailed Guides

• Developer Documentation: Details on how to extend and customize the MCP server, and how to integrate with various tools and services.
• User Guide: Instructions for end-users on how to configure and use the MCP server.

📖 References

• MCP Protocol Quick Start (English)
• MCP Official Documentation