Skip to main content
Glama
EthanPany

thermal-mcp

by EthanPany
README.md
# thermal-mcp ๐Ÿงพ

**Print beautiful HTML & Markdown on a $30 thermal receipt printer, straight from your AI agent.**

thermal-mcp is an [MCP](https://modelcontextprotocol.io) server that turns any 58mm ESC/POS thermal printer into a typographic output device for LLM agents. The agent hands over Markdown or HTML; the server renders it in headless Chromium (2ร— supersampled), converts it to 1-bit with quality dithering, encodes ESC/POS, and ships it to the printer over USB, Bluetooth serial, or CUPS โ€” wired preferred, automatically.

```
agent โ”€โ”€MCPโ”€โ”€โ–บ render (Chromium @2x) โ”€โ”€โ–บ 1-bit (Atkinson/Jarvis/Bayer + CLAHE)
              โ”€โ”€โ–บ ESC/POS (heat-tuned, blank-line elision) โ”€โ”€โ–บ USB / BT / CUPS
```

## Why it's nice

- **Markdown in, ticket out** โ€” GFM plus syntax-highlighted code (monochrome scheme), ```mermaid``` diagrams, LaTeX math (KaTeX), task lists, tables, remote images. Three type-size tiers.
- **Full custom HTML** when the agent wants layout control: real Chromium, so flexbox/grid/SVG/emoji/web fonts all work.
- **Offline font library** โ€” Geist Sans/Mono, Inter, JetBrains Mono, Space Grotesk, Lora, Playfair Display, Caveat, Noto Sans SC, plus Font Awesome icons, all bundled and loaded via `file://`.
- **Print quality obsessed** โ€” supersampled rendering, CLAHE + unsharp photo pipeline, three dither algorithms, ESC/POS heat/density tuning (`ESC 7`, `DC2 #`), blank-line elision, paced Bluetooth writes. Calibrated on real hardware.
- **Exact previews** โ€” `preview_*` tools return the true 1-bit image that will print, so agents iterate without wasting paper.
- **`<img data-qr="...">`** becomes a scannable QR code, generated server-side.

## Tools

| tool | what it does |
|---|---|
| `print_markdown { markdown, size?, feed_lines? }` | quick path: markdown โ†’ house-styled ticket |
| `preview_markdown { markdown, size? }` | exact 1-bit preview, no paper |
| `print_html { html, mode?, algorithm?, feed_lines? }` | full custom design |
| `preview_html { html, mode?, algorithm? }` | exact 1-bit preview |
| `printer_status {}` | transport + printer state |
| `design_guide {}` | returns the full design guide (fonts, layout, house style) โ€” client-agnostic, works in Claude Desktop |

`mode`: `auto` (detect photos, keep text sharp) / `text` / `photo` ยท `algorithm`: `atkinson` / `jarvis` / `bayer` ยท `size`: `large` 24px / `medium` 19px / `small` 14px.

## Setup

```sh
git clone https://github.com/EthanPany/thermal-mcp && cd thermal-mcp
npm install
npx puppeteer browsers install chrome
npm run smoke   # renders out/smoke.png without a printer
```

Register with Claude Code:

```sh
claude mcp add --scope user thermal --env THERMAL_TRANSPORT=auto \
  -- "$(which node)" /absolute/path/to/thermal-mcp/node_modules/tsx/dist/cli.mjs \
     /absolute/path/to/thermal-mcp/src/index.ts
```

Claude Desktop (`claude_desktop_config.json`). Use **absolute paths** โ€” GUI
apps launch with a minimal `PATH` and won't find `npx`/`tsx` on their own:

```json
"thermal": {
  "command": "/absolute/path/to/node",
  "args": [
    "/absolute/path/to/thermal-mcp/node_modules/tsx/dist/cli.mjs",
    "/absolute/path/to/thermal-mcp/src/index.ts"
  ],
  "env": { "THERMAL_TRANSPORT": "auto" }
}
```

**Design guidance.** In **Claude Code**, optionally install the skill so it
auto-loads:

```sh
ln -s /absolute/path/to/thermal-mcp/skills/thermal-print ~/.claude/skills/thermal-print
```

In **Claude Desktop** (or any other MCP client) the skill mechanism isn't
available, but the same guidance is served over MCP by the **`design_guide`
tool** โ€” the agent calls it before designing. No extra setup.

## Printer configuration

`THERMAL_TRANSPORT=auto` (default) probes in order: **USB** (any printer-class device) โ†’ **Bluetooth SPP serial** (`THERMAL_DEVICE`, default `/dev/cu.MPT-II`) โ†’ **dry-run** (writes PNG + ESC/POS bytes to `out/`). Or force `usb` / `serial` / `lp-raw` / `lp-image` / `file`.

Darkness: by default the server sends only `ESC @` and uses the printer's
firmware-default darkness โ€” clean, no bleed. Hardware heat/density commands are
**opt-in** because some clone firmwares (incl. the MPT-II tested here) misparse
`ESC 7` and leak a parameter byte as a stray glyph. Set these only if your
firmware honors them and you need to push darker:

| env | meaning | default |
|---|---|---|
| `THERMAL_HEAT_TIME` | ESC 7 n2 โ€” heat pulse ร—10ยตs (darker); enables ESC 7 | unset |
| `THERMAL_HEAT_DOTS` | ESC 7 n1 โ€” dots per strobe = 8ร—(n+1) | 3 (if ESC 7 on) |
| `THERMAL_HEAT_INTERVAL` | ESC 7 n3 โ€” recovery ร—10ยตs (fixes fading) | 60 (if ESC 7 on) |
| `THERMAL_DENSITY` | DC2 # density 0โ€“31; enables DC2 # | unset |
| `THERMAL_BREAK` | DC2 # per-line break time 0โ€“7 | 4 (if DC2 # on) |
| `THERMAL_THIN` | software stroke-thinning 0โ€“2 (0.3โ€“0.6 lightens fat Latin text; >0.7 breaks small/CJK text) | 0 (off) |
| `THERMAL_MAX_PX` | max ticket height in px; taller content is truncated with a warning (roll-saver) | 12000 (~1.5m) |
| `THERMAL_DITHER` | default photo algorithm | atkinson |
| `THERMAL_CHUNK` / `THERMAL_PACE_MS` | Bluetooth pacing | 256 / 30 |

Tested on a Sunydog 58mm (USB `6868:0200`, Bluetooth "MPT-II") on macOS. Any printer speaking `GS v 0` raster should work.

## License

MIT

TDQS

A4.2/5.0

Scored across 6 tools

Disambiguation5/5

Each tool has a distinct purpose: previewing vs printing, HTML vs Markdown, checking status, and reading the design guide. No two tools overlap in function, and the descriptions clarify the exact use case for each.

Naming Consistency4/5

Most tools follow a clear verb_noun pattern: preview_html, print_html, preview_markdown, print_markdown. Two exceptions (printer_status, design_guide) are noun phrases, but they are still intuitive and don't create confusion.

Tool Count5/5

With 6 tools, the set is well-scoped for thermal printing workflows. Each tool earns its place, covering preview, print, status, and guidance without unnecessary bloat.

Completeness5/5

The surface covers the full lifecycle: design (design_guide), validate (preview_*), execute (print_*), and monitor (printer_status). No obvious dead ends or missing essential operations for the domain.

Maintenance

ActivitySlowing
ResponsivenessNo issues