# Sparkplug B MCP server

> Allows an AI client to discover industrial edge nodes and devices, monitor real-time metrics, and send commands over MQTT using the Sparkplug B specification.

- Repository: https://github.com/nagarjunr/iot-mcp-servers
- Page: https://hostedmcp.org/servers/nagarjunr/sparkplug-b
- Transport: stdio
- Stars: 0
- License: MIT
- Latest version: 0.1.0

## Install

### Claude Code

```sh
claude mcp add --env 'SPARKPLUG_HOST_ID=<SPARKPLUG_HOST_ID>' --env 'SPARKPLUG_MQTT_HOST=<SPARKPLUG_MQTT_HOST>' --env 'SPARKPLUG_MQTT_PASSWORD=<YOUR_SPARKPLUG_MQTT_PASSWORD>' sparkplug-b -- uvx sparkplug-b-mcp-server
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "sparkplug-b": {
      "command": "uvx",
      "args": [
        "sparkplug-b-mcp-server"
      ],
      "env": {
        "SPARKPLUG_HOST_ID": "<SPARKPLUG_HOST_ID>",
        "SPARKPLUG_MQTT_HOST": "<SPARKPLUG_MQTT_HOST>",
        "SPARKPLUG_MQTT_PASSWORD": "<YOUR_SPARKPLUG_MQTT_PASSWORD>"
      }
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "sparkplug-b": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "sparkplug-b-mcp-server"
      ],
      "env": {
        "SPARKPLUG_HOST_ID": "<SPARKPLUG_HOST_ID>",
        "SPARKPLUG_MQTT_HOST": "<SPARKPLUG_MQTT_HOST>",
        "SPARKPLUG_MQTT_PASSWORD": "<YOUR_SPARKPLUG_MQTT_PASSWORD>"
      }
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"sparkplug-b","type":"stdio","command":"uvx","args":["sparkplug-b-mcp-server"],"env":{"SPARKPLUG_HOST_ID":"<SPARKPLUG_HOST_ID>","SPARKPLUG_MQTT_HOST":"<SPARKPLUG_MQTT_HOST>","SPARKPLUG_MQTT_PASSWORD":"<YOUR_SPARKPLUG_MQTT_PASSWORD>"}}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "sparkplug-b": {
      "command": "uvx",
      "args": [
        "sparkplug-b-mcp-server"
      ],
      "env": {
        "SPARKPLUG_HOST_ID": "<SPARKPLUG_HOST_ID>",
        "SPARKPLUG_MQTT_HOST": "<SPARKPLUG_MQTT_HOST>",
        "SPARKPLUG_MQTT_PASSWORD": "<YOUR_SPARKPLUG_MQTT_PASSWORD>"
      }
    }
  }
}
```

### Codex

```sh
codex mcp add sparkplug-b --env 'SPARKPLUG_HOST_ID=<SPARKPLUG_HOST_ID>' --env 'SPARKPLUG_MQTT_HOST=<SPARKPLUG_MQTT_HOST>' --env 'SPARKPLUG_MQTT_PASSWORD=<YOUR_SPARKPLUG_MQTT_PASSWORD>' -- uvx sparkplug-b-mcp-server
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.sparkplug-b]
command = "uvx"
args = ["sparkplug-b-mcp-server"]

[mcp_servers.sparkplug-b.env]
SPARKPLUG_HOST_ID = "<SPARKPLUG_HOST_ID>"
SPARKPLUG_MQTT_HOST = "<SPARKPLUG_MQTT_HOST>"
SPARKPLUG_MQTT_PASSWORD = "<YOUR_SPARKPLUG_MQTT_PASSWORD>"
```

### Gemini CLI

```sh
gemini mcp add -s user -e 'SPARKPLUG_HOST_ID=<SPARKPLUG_HOST_ID>' -e 'SPARKPLUG_MQTT_HOST=<SPARKPLUG_MQTT_HOST>' -e 'SPARKPLUG_MQTT_PASSWORD=<YOUR_SPARKPLUG_MQTT_PASSWORD>' sparkplug-b uvx -- sparkplug-b-mcp-server
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "sparkplug-b": {
      "command": "uvx",
      "args": [
        "sparkplug-b-mcp-server"
      ],
      "env": {
        "SPARKPLUG_HOST_ID": "<SPARKPLUG_HOST_ID>",
        "SPARKPLUG_MQTT_HOST": "<SPARKPLUG_MQTT_HOST>",
        "SPARKPLUG_MQTT_PASSWORD": "<YOUR_SPARKPLUG_MQTT_PASSWORD>"
      }
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `SPARKPLUG_HOST_ID` | yes | no | This connector's Sparkplug Host Application ID (used in the spBv1.0/STATE/{id} topic). |
| `SPARKPLUG_MQTT_HOST` | yes | no | MQTT broker hostname or IP. |
| `SPARKPLUG_MQTT_PASSWORD` | no | yes | Broker password, if required |
| `SPARKPLUG_GROUP_ID` | no | no | Restrict discovery/watching to a single Sparkplug Group ID; omit to subscribe to every group |
| `SPARKPLUG_MQTT_PORT` | no | no | MQTT broker port, default 1883 |
| `SPARKPLUG_MQTT_USERNAME` | no | no | Broker username, if required |
| `SPARKPLUG_MQTT_USE_TLS` | no | no | true/false, default false |

## FAQ

### Can I use this with any MQTT broker?

Yes, it works against any MQTT broker that carries Sparkplug B traffic using the open specification without vendor-specific extensions.

### How does the server handle continuous data streams since MCP is request/response?

The server uses a session-based watching mechanism where `start_watch` buffers decoded traffic in the background, and `get_events` allows the client to drain that buffer.

### What metric data types are supported?

It supports various integer, float, boolean, string, datetime, and byte types, including their array variants.
