Emqx MCP Server

🚀 EMQX Custom MCP Server Plugin

This project is a custom MCP (Message Central Protocol) server designed to interact with the EMQX MQTT broker. It enables users to perform operations on the MQTT broker through a Natural Language Processing (NLP) interface, such as listing connected clients, retrieving client details, publishing messages, and disconnecting clients.

🚀 Quick Start

✨ Features

• Interact with EMQX MQTT broker via NLP interface.
• Perform various operations on MQTT broker, including listing clients, getting client details, publishing messages, and disconnecting clients.

📦 Installation

1. Clone the repository

git clone https://github.com/Benniu/emqx-mcp-server.git

2. Install dependencies

Run the following command in the project root directory:

npm install

3. Configure the MCP server

Create a file named config.json and add the following content:

{
  "emqxApiUrl": "https://your-emqx-instance.com:8443/api/v5",
  "apiKey": "<Your API Key>",
  "apiSecret": "<Your API Key>"
}

💻 Usage Examples

Basic Usage

Here are some example dialogues for interacting with the MCP server:

User:

Please list all clients connected to the MQTT broker.

LLM Response:

Here are the clients currently connected to your MQTT broker:
Connected clients:
- Client ID: mqttx_2232bdb1
- Username: test
- Protocol version: MQTT v5
...
Currently, there is 1 client connected to your MQTT broker. Do you need detailed information about this specific client, or would you like to perform other operations on the MQTT broker?

User:

Yes, please provide detailed information about this client.

LLM Response:

I will retrieve detailed information about this client for you.
...
Here are the detailed information of client "mqttx_2232bdb1":

**Basic Information:**
- **Client ID:** mqttx_2232bdb1
- **Username:** test
...
**Connection Details:**
- **Status:** Connected
- **Creation Time:** 2025-03-02T05:29:51.103+00:00
...
Do you want to perform any operations on this client, such as publishing a message to a topic or disconnecting the client?

User:

Please write a poem and send it to the topic '/poem' with a quality of 1.

LLM Response:

I will create a poem for you and publish it to the '/poem' topic via MQTT. Let me complete this operation for you.
...
I have successfully published this poem to the '/poem' topic with a quality of 1. The message has been delivered, ID: 00062F55A1EFB1156ABC481240B30000.

The poem I sent is as follows:

- Signals shuttle in the radio waves,
- Invisible lines connect us,
- Devices communicate in whispers,
- Crossing the digital divide.
- Messages flutter like falling leaves,
- From the cloud into the mortal world,
- Free yet unbound,
- Silently recited in the silence.
- Now machines become the bond,
- Transmitting information globally,
- The future steps lightly,
- Moving forward in the long river of time.

Do you want to continue creating poems or perform other operations?

User:

Please disconnect the client 'mqttx_2232bdb1'.

LLM Response:

I have successfully disconnected the client 'mqttx_2232bdb1'. If you need further operations, please let me know at any time!

Advanced Usage

Here are some more usage examples:

1. List all clients

User: "Please list all clients connected to the MQTT broker."

2. Get client details

User: "Please provide detailed information about the client 'mqttx_2232bdb1'."

3. Publish a message

User: "Please publish a message to the topic '/test' with the content 'Hello EMQX'."

4. Disconnect a client

User: "Please disconnect the client 'mqttx_2232bdb1'."

📄 License

This project is licensed under the MIT License. The specific terms are as follows:

Copyright (c) 2024, Your Name <Your Email>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

🔧 Technical Details

Project Goals

• Scalability: Support more MQTT-related operations.
• Usability: Provide a simple command-line and API interface.
• Reliability: Ensure the accuracy of all operations.

If you have any questions or suggestions, please feel free to contact me!