Skip to main content

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.

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.

Web UI language

The web UI supports English (en) and Chinese (zh).

  • Config file: ~/.whiteboard-mcp/config.yaml
  • Key: language, value en or zh

If language is not set in that file (or the file is missing), the UI language follows the browser Accept-Language header: Chinese (zh, zh-CN, etc.) maps to Chinese; anything else defaults to English.

Example:

language: zh

You can edit this file by hand, or use More (⋯) → Settings in the web UI, choose a language, and click Save (the server writes the same file and reloads the page).

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 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).

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

whiteboard_mcp-0.2.0.tar.gz (64.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whiteboard_mcp-0.2.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file whiteboard_mcp-0.2.0.tar.gz.

File metadata

  • Download URL: whiteboard_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 64.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for whiteboard_mcp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1f0abdada77f008e2b2c75e93eecd9572c5f14902e6168e7fdd9575501ac6c66
MD5 be417e162e96bb52d4a648c635a05ed3
BLAKE2b-256 49676c9ef59c32b388b5547e9ed06ef82b15c746c3c83d714af963897dda6c94

See more details on using hashes here.

File details

Details for the file whiteboard_mcp-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: whiteboard_mcp-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for whiteboard_mcp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 307f9dae09a4aff3b1c4ebecbf9adfc42edc3d14275e243e9cec84aaab0360a6
MD5 5ac07d7281b370185988bb9bd1e4fc8b
BLAKE2b-256 8a1e5511ea55b78004a4557ef80ab0fdba9ab7d0cd23db93ebd116e99b6c6f18

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page