Skip to content

docs(readme): Add Docker usage instructions #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(readme): Add Docker usage instructions #19

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53f5a9f
docs(readme): Add Docker usage instructions
Oct 15, 2025
14b5bf0
docs(readme): Updated the Docker run command to include the transport…
Oct 17, 2025
4c48efe
docs(readme): Reorganize the location of the Docker usage instructions
Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ On Window system:

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

**Access Points:**
- SSE: `http://localhost:3033/sse`
Copy link
Owner

@hustcc hustcc Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

端口默认都是 1122 吧？

Copy link
Collaborator Author

@Susuperli Susuperli Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sse 默认是 3033 呀

- Streamable: `http://localhost:1122/mcp`

**Available Docker Tags:**
- `susuperli/mcp-mermaid:latest` - Latest stable version
- View all available tags at [Docker Hub](https://hub.docker.com/repository/docker/susuperli/mcp-mermaid/tags)


## 🚰 Run with SSE or Streamable transport

Expand Down Expand Up @@ -155,6 +163,21 @@ node build/index.js --transport streamable --port 1122
node build/index.js --transport stdio
```

## 🐳 Docker Usage

Run MCP Mermaid with Docker:

```bash
# Pull the image
docker pull susuperli/mcp-mermaid:latest

# Run with SSE transport (default)
docker run -p 3033:3033 susuperli/mcp-mermaid:latest --transport sse

# Run with streamable transport
docker run -p 1122:1122 susuperli/mcp-mermaid:latest --transport streamable --port 1122
```

## 📄 License

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