Coreflux MCP Server

by CorefluxCommunity

3 stars
159 downloads
Not rated
GitHub Website

About

An MCP server that connects to a Coreflux MQTT broker, providing Coreflux and MQTT actions as tools for AI assistants.

Details

Author
CorefluxCommunity
GitHub stars
3
Downloads
159
Categories
Other, Communication, Automation

- MQTT integration with full TLS support
- Complete Coreflux API access (models, actions, rules, routes)
- LOT code generation via Coreflux Copilot API
- Dynamic discovery and listing of available actions
- Comprehensive health monitoring and system checks
- Docker and Kubernetes deployment support

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Coreflux MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Deploy via Docker (recommended) or install Python dependencies and run python server.py. Configure by editing .env or using the interactive setup assistant (python setup_assistant.py). Connect Claude Desktop by adding the server configuration to claude_desktop_config.json.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "coreflux mcp server": {
            "CorefluxMCPServer": {
                "command": "python",
                "args": [
                    "setup_assistant.py"
                ]
            }
        }
    }
}

McpServers

{
    "CorefluxMCPServer": {
        "command": "python",
        "args": [
            "setup_assistant.py"
        ]
    }
}

"Please run a comprehensive health check on the Coreflux MCP server"

``

Monitoring Metrics

The server provides detailed metrics: - Connection Status - MQTT broker connectivity - Message Processing - Queue size and processing rates - System Resources - Memory and CPU usage - Error Rates - Failed operations and error statistics - API Status - Copilot API availability and response times

Alerting

Configure alerts for: - Connection failures - High error rates - Resource exhaustion - Security events

🀝 Contributing

We welcome contributions! Please see our contribution guidelines:

Development Process

1. Fork the repository 2. Create a feature branch:
git checkout -b feature/amazing-feature 3. Install development dependencies: pip install -r requirements-dev.txt 4. Setup pre-commit hooks: pre-commit install 5. Make your changes with tests 6. Run quality checks: make quality-check 7. Commit your changes: git commit -am 'Add amazing feature' 8. Push to the branch: git push origin feature/amazing-feature 9. Create a Pull Request

Code Standards

- Python 3.11+ compatibility - Type hints for all functions - Comprehensive tests with >90% coverage - Security scanning with bandit - Code formatting with black and isort - Documentation for all public APIs

πŸ“„ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

πŸ†˜ Support & Troubleshooting

Common Issues

Connection Refused
` Error: MQTT connection failed ` - Check broker hostname and port - Verify network connectivity - Confirm TLS configuration Authentication Failed ` Error: Authentication failed ` - Verify username/password - Check API key validity - Confirm broker permissions TLS Handshake Failed ` Error: TLS handshake failed ` - Verify certificate paths - Check certificate validity - Confirm TLS version compatibility

Debug Mode

Enable detailed logging for troubleshooting:
`bash export LOG_LEVEL=DEBUG python server.py `

Getting Help

- GitHub Issues: Report bugs and request features - Discussions: Community support and questions - Documentation: Complete documentation - Security Issues: Report to security@coreflux.org

πŸ—ΊοΈ Roadmap

Current Status: v1.0.0 βœ…

- βœ… Core MQTT functionality - βœ… Copilot API integration - βœ… Enterprise security features - βœ… Comprehensive testing - βœ… Production deployment support

Upcoming Features

- v1.1.0 - Enhanced monitoring and metrics - v1.2.0 - Additional Coreflux API endpoints - v1.3.0 - WebSocket support for real-time data - v2.0.0 - Multi-broker support and federation ---

πŸ“‹ Quick Reference

Essential Commands

``bash
No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.