diff --git a/README.md b/README.md index 82e4623..33183ba 100644 --- a/README.md +++ b/README.md @@ -24,28 +24,40 @@ ### Installation -```bash -# Install from PyPI -pip install mcmqtt +**Recommended: Use `uvx` for instant execution** (no installation needed): -# Or use uv (recommended) +```bash +# Run directly with uvx (recommended) +uvx mcmqtt --help + +# Start STDIO server for MCP clients +uvx mcmqtt + +# HTTP mode for web integration +uvx mcmqtt --transport http --port 8080 +``` + +**If you insist on traditional installation**: + +```bash +# Install with uv uv add mcmqtt -# Or install directly with uvx -uvx mcmqtt --help +# Or use pip +pip install mcmqtt ``` ### Instant MQTT Magic ```bash -# Start FastMCP MQTT server with embedded broker -mcmqtt --transport stdio --auto-broker +# Start FastMCP MQTT server (default STDIO mode) - Just works! +uvx mcmqtt # HTTP mode for web integration -mcmqtt --transport http --port 8080 --auto-broker +uvx mcmqtt --transport http --port 8080 -# Connect to existing broker -mcmqtt --mqtt-host mqtt.example.com --mqtt-port 1883 +# Connect to existing broker (optional) +uvx mcmqtt --mqtt-host mqtt.example.com --mqtt-port 1883 ``` ### MCP Integration @@ -53,8 +65,8 @@ mcmqtt --mqtt-host mqtt.example.com --mqtt-port 1883 Add to your Claude Code MCP configuration: ```bash -# Add mcmqtt as an MCP server -claude mcp add task-buzz "uvx mcmqtt --broker mqtt://localhost:1883" +# Add mcmqtt as an MCP server (zero configuration!) +claude mcp add task-buzz -- uvx mcmqtt # Test the connection claude mcp test task-buzz