A web-based whiteboard service
Project description
A Web-based Whiteboard with MCP interface
whiteboard-mcp is a simple whiteboard web application, providing a convenient way for displaying Chatbot/LLM's output.
Features
- Web whiteboard — Browser UI to show content pushed by agents or other clients; good for demos and side-by-side LLM output.
- Any screen — Open the board URL in a browser on any monitor, projector, or device on your network.
- Dual MCP transports — Streamable HTTP at
/mcpand SSE at/ssefor clients that only support one style. - REST API —
GET/POST /api/contentfor non-MCP integrations; history list/restore/delete under/api/history. - History — Server-side history of updates; reopen a past version from the history UI (and via the history API).
- Export — Save the current view as HTML or Markdown from the menu; Print / PDF (browser print-to-PDF) when the board shows HTML or Markdown.
- Bilingual UI — English and Chinese interface, file or in-app settings.
Install
From PYPI
pip install whiteboard-mcp
# or:
# uv tool install whiteboard-mcp
whiteboard-mcp
From source
git clone .../whiteboard-mcp
cd whiteboard-mcp
uv run whiteboard_mcp
The server listens on 0.0.0.0:5000 by default.
MCP endpoints
| Transport | URL (local) |
|---|---|
| StreamableHTTP | http://127.0.0.1:5000/mcp (POST /mcp) |
| SSE (+ messages) | http://127.0.0.1:5000/sse (+ POST /sse/messages/) |
Use your machine's LAN IP instead of 127.0.0.1 when connecting from another device on the same network.
MCP tools
The MCP server exposes these tools (names as registered with clients):
| Tool | Purpose |
|---|---|
update_whiteboard_url |
Set the board to load a URL (url). |
update_whiteboard_html |
Render raw HTML (html). |
update_whiteboard_markdown |
Render Markdown (markdown). |
MCP configure
Standard /mcp API
Clients that support Streamable HTTP natively should point their MCP server URL at http://127.0.0.1:5000/mcp (adjust host/port for LAN as needed).
Hermes-Agent MCP config example:
Add an HTTP transport entry under mcp_servers in ~/.hermes/config.yaml, then restart Hermes. Example:
mcp_servers:
whiteboard:
url: "http://127.0.0.1:5000/mcp"
Compatible /sse API
For example you can use mcp-remote to connect /sse API:
{
"mcpServers": {
"whiteboard-mcp": {
"command": "npx",
"args": [
"mcp-remote",
"http://127.0.0.1:5000/sse",
"--allow-http"
]
}
}
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file whiteboard_mcp-0.2.1.tar.gz.
File metadata
- Download URL: whiteboard_mcp-0.2.1.tar.gz
- Upload date:
- Size: 65.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
48078637bd86fe1f43fa1d4058f258450e3aa98de9b429c1062e138b112f370e
|
|
| MD5 |
210e4fc96159505c9c67bed175be866c
|
|
| BLAKE2b-256 |
31ad5a23959c411c90d9678ba9d84298c71363d7a297e07a569428e68cd767ac
|
File details
Details for the file whiteboard_mcp-0.2.1-py3-none-any.whl.
File metadata
- Download URL: whiteboard_mcp-0.2.1-py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e0d1b2f538affff586a4c256ee5efd4e0b0ef40a2cd05ed3d26e5f240bdf06b
|
|
| MD5 |
15f9ddb926fc3ecb493f32b590f992f7
|
|
| BLAKE2b-256 |
049d5e237adfaef0041fb33c0fb68180383967395cac9bb17ad65928d339216b
|