Skip to content

Commit 8846e5f

Browse files
authored
docs(readme): Add Docker usage instructions (#19)
1 parent d1ff657 commit 8846e5f

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,14 @@ On Window system:
5555

5656
Also, you can use it on aliyun, modelscope, glama.ai, smithery.ai or others with HTTP, SSE Protocol.
5757

58+
**Access Points:**
59+
- SSE: `http://localhost:3033/sse`
60+
- Streamable: `http://localhost:1122/mcp`
61+
62+
**Available Docker Tags:**
63+
- `susuperli/mcp-mermaid:latest` - Latest stable version
64+
- View all available tags at [Docker Hub](https://hub.docker.com/repository/docker/susuperli/mcp-mermaid/tags)
65+
5866

5967
## 🚰 Run with SSE or Streamable transport
6068

@@ -160,6 +168,21 @@ node build/index.js --transport streamable --port 1122
160168
node build/index.js --transport stdio
161169
```
162170

171+
## 🐳 Docker Usage
172+
173+
Run MCP Mermaid with Docker:
174+
175+
```bash
176+
# Pull the image
177+
docker pull susuperli/mcp-mermaid:latest
178+
179+
# Run with SSE transport (default)
180+
docker run -p 3033:3033 susuperli/mcp-mermaid:latest --transport sse
181+
182+
# Run with streamable transport
183+
docker run -p 1122:1122 susuperli/mcp-mermaid:latest --transport streamable --port 1122
184+
```
185+
163186
## 📄 License
164187

165188
MIT@[hustcc](https://github.com/hustcc).

0 commit comments

Comments
 (0)