Skip to main content

A Model Context Protocol (MCP) server for MQTT

Project description

MQTT MCP Server

A lightweight Model Context Protocol (MCP) server that connects LLM agents to MQTT devices in a secure, standardized way, enabling seamless integration of AI-driven workflows with Building Automation (BAS), Industrial Control (ICS) and Smart Home systems, allowing agents to monitor real-time sensor data, actuate devices, and orchestrate complex automation tasks.

test codecov PyPI - Version

Getting Started

Use uv to add and manage the MQTT MCP server as a dependency in your project, or install it directly via uv pip install or pip install. See the Installation section of the documentation for full installation instructions and more details.

uv add mqtt-mcp

The server can be embedded in and run directly from your application. By default, it exposes a Streamable HTTP endpoint at http://127.0.0.1:8000/mcp/.

# app.py
from mqtt_mcp import MQTTMCP

mcp = MQTTMCP()

if __name__ == "__main__":
    mcp.run(transport="http")

It can also be launched from the command line using the provided CLI without modifying the source code.

mqtt-mcp

Or in an ephemeral, isolated environment using uvx. Check out the Using tools guide for more details.

uvx mqtt-mcp

Configuration

For the use cases where most operations target a specific MQTT broker its connection settings (host and port) can be specified at runtime using environment variables so that all prompts that omit explicit connection parameters will be routed to this broker.

export MQTT_MCP_MQTT__HOST=10.0.0.1
export MQTT_MCP_MQTT__PORT=1883

These settings can also be specified in a .env file in the working directory.

# .env
mqtt_mcp_mqtt__host=10.0.0.1
mqtt_mcp_mqtt__port=1883

MCP Inspector

To confirm the server is up and running and explore available resources and tools, run the MCP Inspector and connect it to the MQTT MCP server at http://127.0.0.1:8000/mcp/. Make sure to set the transport to Streamable HTTP.

npx @modelcontextprotocol/inspector

s01

Core Concepts

The MQTT MCP server leverages FastMCP 2.0's core building blocks - resource templates, tools, and prompts - to streamline MQTT receive and publish operations with minimal boilerplate and a clean, Pythonic interface.

Receive Message

Each topic on a device is mapped to a resource (and exposed as a tool) and resource templates are used to specify connection details (host, port) and receive parameters (topic, timeout).

@mcp.resource("mqtt://{host}:{port}/{topic*}")
@mcp.tool(
    annotations={
        "title": "Receive Message",
        "readOnlyHint": True,
        "openWorldHint": True,
    }
)
async def receive_message(
    topic: str,
    host: str = settings.mqtt.host,
    port: int = settings.mqtt.port,
    timeout: int = 60,
) -> str:
    """Receives a message published to the specified topic, if any."""
    ...

Publish Message

Publish operations are exposed as a tool, accepting the same connection details (host, port) and allowing to publish a message to a specific topic in a single, atomic call.

@mcp.tool(
    annotations={
        "title": "Publish Message",
        "readOnlyHint": False,
        "openWorldHint": True,
    }
)
async def publish_message(
    topic: str,
    message: str,
    host: str = settings.mqtt.host,
    port: int = settings.mqtt.port,
) -> str:
    """Publishes a message to the specified topic."""
    ...

Authentication

To enable authentication using the built-in AuthKit provider for the Streamable HTTP transport, provide the AuthKit domain and redirect URL in the .env file. Check out the AuthKit Provider section for more details.

Interactive Prompts

Structured response messages are implemented using prompts that help guide the interaction, clarify missing parameters, and handle errors gracefully.

@mcp.prompt(name="mqtt_help", tags={"mqtt", "help"})
def mqtt_help() -> list[Message]:
    """Provides examples of how to use the MQTT MCP server."""
    ...

Here are some example text inputs that can be used to interact with the server.

Publish {"foo":"bar"} to topic "devices/foo" on 127.0.0.1:1883.
Receive a message from topic "devices/bar", waiting up to 30 seconds.

Examples

The examples folder contains sample projects showing how to integrate with the MQTT MCP server using various client APIs to provide tools and context to LLMs.

Docker

The MQTT MCP server can be deployed as a Docker container as follows:

docker run -dit \
  --name mqtt-mcp \
  --restart=always \
  -p 8080:8000 \
  --env-file .env \
  ghcr.io/ezhuk/mqtt-mcp:latest

This maps port 8080 on the host to the MCP server's port 8000 inside the container and loads settings from the .env file, if present.

License

The server is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqtt_mcp-0.2.5.tar.gz (150.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mqtt_mcp-0.2.5-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file mqtt_mcp-0.2.5.tar.gz.

File metadata

  • Download URL: mqtt_mcp-0.2.5.tar.gz
  • Upload date:
  • Size: 150.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mqtt_mcp-0.2.5.tar.gz
Algorithm Hash digest
SHA256 a7fa98622742024155161c5b11e712cd306b059d1af0884f8e55d8a05b605028
MD5 c0eaa7b4e5bf8f6f6b7a346f9cb97469
BLAKE2b-256 6134cac3723007d273c59fcc412e6d6e945f8ea60c4659a909ece0a3a90070bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtt_mcp-0.2.5.tar.gz:

Publisher: pypi.yml on ezhuk/mqtt-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mqtt_mcp-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: mqtt_mcp-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mqtt_mcp-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 53d0079f53c3ac8b59ad9130ffa42a0a30c90bbf3ea8309ed98811b7dd4bc0f2
MD5 6a5eb79a0018b651ca41894cf8b4ab5a
BLAKE2b-256 5f32d8bbe4bfed80d2474dca62ac8417b7a7097f1c2a277af1bd01a010bf3fd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtt_mcp-0.2.5-py3-none-any.whl:

Publisher: pypi.yml on ezhuk/mqtt-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page