Coreflux MCP Server

- Python 3.11 or higher
- Docker (optional, for containerized deployment)
- Access to a Coreflux MQTT broker
- Coreflux Copilot API key (optional, for AI assistance)

- 🐳 Container Ready: Full Docker and Kubernetes deployment support with health checks
- 🔄 CI/CD Pipeline: GitHub Actions with automated testing, security scanning, and quality checks
- 📦 Development Tools: Pre-commit hooks, code formatting, linting, and documentation generation
- ⚙️ Easy Setup: Interactive setup assistant with validation and testing
- 📚 Rich Documentation: API documentation, security guides, and deployment instructions

1. Clone and configure:
``bash
git clone https://github.com/CorefluxCommunity/Coreflux-MQTT-MCP-Server.git
cd Coreflux-MQTT-MCP-Server
cp .env.example .env

`

2. Deploy with Docker:
`bash
docker-compose up -d


1. Clone and configure:

   

1. Clone and setup:
`bash
git clone https://github.com/CorefluxCommunity/Coreflux-MQTT-MCP-Server.git
cd Coreflux-MQTT-MCP-Server
`

2. Install dependencies:
`bash
pip install -r requirements.txt

The server includes a comprehensive setup assistant that guides you through configuration:

`bash
python setup_assistant.py
`

The assistant helps with:
- 🔧 MQTT broker connection settings
- 🔐 TLS certificate configuration
- 🤖 Coreflux Copilot API integration
- 📝 Logging and monitoring setup
- ✅ Configuration validation and testing

Use the setup assistant when:
- Creating initial configuration
- Updating existing settings
- Troubleshooting connection issues
- Setting up TLS certificates
- Migrating between environments

Copy .env.example to .env and configure:



MQTT_BROKER=your-broker-host.com

MQTT_PORT=8883

MQTT_USER=your-username

MQTT_PASSWORD=your-password

MQTT_USE_TLS=true

MQTT_CA_CERT=/path/to/ca.crt

MQTT_CERT_FILE=/path/to/client.crt  

MQTT_KEY_FILE=/path/to/client.key
LOG_LEVEL=INFO

LOG_FILE=/var/log/coreflux-mcp.log

For better security, use environment variables instead of hardcoding credentials:

`json
{
"mcpServers": {
"coreflux": {
"command": "python",
"args": ["/path/to/your/server.py"],
"env": {
"MQTT_BROKER": "${COREFLUX_MQTT_BROKER}",
"MQTT_PORT": "${COREFLUX_MQTT_PORT}",
"MQTT_USER": "${COREFLUX_MQTT_USER}",
"MQTT_PASSWORD": "${COREFLUX_MQTT_PASSWORD}",
"DO_AGENT_API_KEY": "${COREFLUX_API_KEY}"
}
}
}
}


1. Install development dependencies:

   

Ask Claude to help with Coreflux automation:

Robust validation system that checks:

- Environment Variables - Validates all required configuration
- File Permissions - Ensures certificate files are accessible
- Network Connectivity - Tests MQTT broker connectivity
- API Availability - Validates Copilot API access

- GitHub Issues: Report bugs and request features
- Discussions: Community support and questions
- Documentation: Complete documentation
- Security Issues: Report to [email protected]

python setup_assistant.py # Interactive setup
make validate # Validate configuration

docker-compose up -d # Docker deployment
make docker-build # Build Docker image