plug.directory
Add my server

Install Sparkplug B in Goose

What you need first

  • Goose, installed.
  • uv, which gives the uvx command the server starts with.
  • Your own values for YOUR_SPARKPLUG_MQTT_HOST,YOUR_SPARKPLUG_HOST_ID.

Steps

  1. Open ~/.config/goose/config.yaml. On Windows it is %APPDATA%\Block\goose\config\config.yaml.
  2. Add this entry. If the file already has extensions, add only the entry inside it.
extensions:
  "sparkplug-b":
    type: stdio
    name: "sparkplug-b"
    enabled: true
    cmd: "uvx"
    args: ["sparkplug-b-mcp-server==0.1.0"]
    env_keys: []
    envs: { "SPARKPLUG_MQTT_HOST": "YOUR_SPARKPLUG_MQTT_HOST", "SPARKPLUG_HOST_ID": "YOUR_SPARKPLUG_HOST_ID" }
    timeout: 300
  1. Replace YOUR_SPARKPLUG_MQTT_HOST,YOUR_SPARKPLUG_HOST_ID with your own values.
  2. Save the file and start a new Goose session.

Check it worked

Ask Goose: List the tools of sparkplug-b.

If it does not start

spawn uvx ENOENT
uv is not on the PATH that Goose sees. Install it, or write the full path of uvx in the config.
The server starts, but its tools fail
A YOUR_… placeholder is still in the config, or its value is wrong.
Nothing changes after a restart
The file is not valid YAML any more. Check that the entry is indented like the lines around it.

Back to Sparkplug B