Simplify to clean zero-config FastMCP experience
- Remove complex auto-broker startup logic - Clean CLI: uvx mcmqtt just works in STDIO mode - MCP tools handle broker spawning dynamically - Updated README for zero-configuration experience - Ready for publication with clean architecture
This commit is contained in:
parent
2f2a37376d
commit
d0e84c782c
38
README.md
38
README.md
@ -24,28 +24,40 @@
|
|||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
```bash
|
**Recommended: Use `uvx` for instant execution** (no installation needed):
|
||||||
# Install from PyPI
|
|
||||||
pip install mcmqtt
|
|
||||||
|
|
||||||
# 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
|
uv add mcmqtt
|
||||||
|
|
||||||
# Or install directly with uvx
|
# Or use pip
|
||||||
uvx mcmqtt --help
|
pip install mcmqtt
|
||||||
```
|
```
|
||||||
|
|
||||||
### Instant MQTT Magic
|
### Instant MQTT Magic
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Start FastMCP MQTT server with embedded broker
|
# Start FastMCP MQTT server (default STDIO mode) - Just works!
|
||||||
mcmqtt --transport stdio --auto-broker
|
uvx mcmqtt
|
||||||
|
|
||||||
# HTTP mode for web integration
|
# HTTP mode for web integration
|
||||||
mcmqtt --transport http --port 8080 --auto-broker
|
uvx mcmqtt --transport http --port 8080
|
||||||
|
|
||||||
# Connect to existing broker
|
# Connect to existing broker (optional)
|
||||||
mcmqtt --mqtt-host mqtt.example.com --mqtt-port 1883
|
uvx mcmqtt --mqtt-host mqtt.example.com --mqtt-port 1883
|
||||||
```
|
```
|
||||||
|
|
||||||
### MCP Integration
|
### MCP Integration
|
||||||
@ -53,8 +65,8 @@ mcmqtt --mqtt-host mqtt.example.com --mqtt-port 1883
|
|||||||
Add to your Claude Code MCP configuration:
|
Add to your Claude Code MCP configuration:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Add mcmqtt as an MCP server
|
# Add mcmqtt as an MCP server (zero configuration!)
|
||||||
claude mcp add task-buzz "uvx mcmqtt --broker mqtt://localhost:1883"
|
claude mcp add task-buzz -- uvx mcmqtt
|
||||||
|
|
||||||
# Test the connection
|
# Test the connection
|
||||||
claude mcp test task-buzz
|
claude mcp test task-buzz
|
||||||
|
Loading…
x
Reference in New Issue
Block a user