Skip to main content

Generic MCP server exposing a scan tool to network (eSCL/AirScan) and USB (WIA/SANE/TWAIN) scanners.

Project description

scanner-mcp

License: MIT Python 3.10+ Platform MCP Stars

Let Claude scan and read paper documents from any USB or network scanner.

Ask Claude to scan a document; it calls the scan_document tool and reads the page back

A generic MCP server that exposes a scanning tool to Claude (and any other MCP client). It works with network scanners through the standard eSCL / AirScan / Mopria protocol and with USB scanners through the platform driver stack — WIA on Windows and SANE on Linux/macOS. No vendor-specific driver code.

When Claude needs to read a paper document, it can call scan_document, and the page image is returned inline so Claude can read it directly (optionally OCR'd to text, or saved as PDF).

What it exposes

Tool Purpose
list_scanners Discover every scanner reachable from this machine (network + USB).
scan_document Scan a page/stack and return it as inline images, a saved file, and/or OCR text.

Backends are auto-detected and degrade gracefully — the same server runs on any OS and lights up whatever scanners it can reach:

  • eSCL (_uscan._tcp mDNS) — driverless network MFPs/scanners. Cross-platform.
  • WIA — USB (and some network) scanners on Windows, driven via PowerShell COM.
  • TWAIN — Windows scanners that expose only a TWAIN data source (older/pro units with no usable WIA driver). Optional; needs pytwain + a TWAIN DSM (see below).
  • SANE (scanimage) — USB/network scanners on Linux and macOS.

Install

pip install scanner-mcp
# optional OCR support (also needs the Tesseract binary installed):
pip install "scanner-mcp[ocr]"
# optional TWAIN backend, Windows only (also needs a TWAIN DSM, see below):
pip install "scanner-mcp[twain]"
Or install from source (for development)
git clone https://github.com/AminHA1248/scanner-mcp
cd scanner-mcp
python -m venv .venv
# Windows:  .venv\Scripts\activate
# macOS/Linux:  source .venv/bin/activate
pip install -e ".[twain]"    # editable install; add [ocr] too if you want OCR

Platform prerequisites:

  • Windows: nothing extra for WIA — it and PowerShell ship with Windows. Install the scanner's normal Windows driver so it appears in Devices.
    • TWAIN (optional): install pytwain (pip install -e ".[twain]") and make sure a TWAIN DSM is present. 64-bit Python needs TWAINDSM.dll (shipped by most TWAIN 2.x drivers or the TWAIN DSM redistributable); 32-bit Python can use the classic twain_32.dll. If neither is installed, the TWAIN backend just stays disabled.
  • Linux: sudo apt install sane-utils (provides scanimage).
  • macOS: brew install sane-backends for USB; network scanners work via eSCL with no extras.
  • Network scanners: just be on the same LAN/subnet; mDNS handles discovery.

Connect it to Claude

Claude Desktop — one-click extension (easiest)

Download scanner-mcp-<version>.mcpb from the latest release and open it via Settings → Extensions → Install extension…. Requires Python 3.10+ with pip install scanner-mcp (the extension tells you if it's missing). Details: docs/EXTENSION.md.

Claude Desktop — manual config

Edit claude_desktop_config.json (Settings → Developer → Edit Config):

{
  "mcpServers": {
    "scanner": {
      "command": "scanner-mcp"
    }
  }
}

If scanner-mcp isn't found (its Scripts/bin dir isn't on Claude's PATH), use the full path to the launcher — e.g. C:\Users\you\...\Scripts\scanner-mcp.exe on Windows or /path/to/venv/bin/scanner-mcp on macOS/Linux — or python -m scanner_mcp.server.

Claude Code (CLI)

claude mcp add scanner -- scanner-mcp

Restart the client, then ask Claude: "List my scanners" or "Scan the document on the glass and read it."

How you actually run it

You normally don't launch anything yourself — Claude Desktop/Code starts the scanner-mcp server in the background (per the config above) and calls its tools when you ask. Running scanner-mcp by hand just starts the MCP server, which waits silently for JSON-RPC on stdin; it is not an interactive shell.

To test the hardware without Claude, use the bundled CLI, test_scan.py:

# from the project folder, using the venv's Python
python test_scan.py --list                 # discover scanners
python test_scan.py --dpi 300              # scan (auto-selects if only one)
python test_scan.py --scanner "<id>" --source adf --format pdf

Configuration (env vars)

Variable Default Meaning
SCANNER_MCP_SAVE_DIR ~/Scans Where scans are written.
SCANNER_MCP_LOG INFO Log level.

scan_document options

scanner_id (from list_scanners; auto if only one), source (auto/platen/adf/adf-duplex), resolution (DPI), color_mode (color/gray/lineart), output_format (png/jpeg/pdf), save_dir, return_image (inline images for Claude to read), ocr (extract text).

Notes & limitations

  • eSCL covers most scanners sold in the last ~decade (anything "AirPrint/AirScan" or "Mopria" capable). Older USB-only units go through WIA/SANE instead.
  • PDF output for multi-page WIA scans is assembled with Pillow.
  • HTTPS eSCL devices use self-signed certs, so TLS verification is disabled for them (typical for LAN scanners); prefer a trusted network.
  • This server performs local hardware I/O only — it does not send anything to the cloud.

Privacy Policy

scanner-mcp runs entirely on your machine and collects no data — no telemetry, no analytics, no network transmission of your scans. Scanned files are saved only to your local disk (default ~/Scans) and returned to the MCP client you asked to scan. Full policy: PRIVACY.md.

License

MIT

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

scanner_mcp-0.1.1.tar.gz (305.5 kB view details)

Uploaded Source

Built Distribution

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

scanner_mcp-0.1.1-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file scanner_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: scanner_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 305.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scanner_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 516795d86ae71c0c8606ba3b7b079d527e2492fde01c775c1b072f96c2c68262
MD5 a874689f905757361102fe3d6dedac97
BLAKE2b-256 865fd4f079f62aa23caa4d435a870cd1e2cd5eda6ad9d779a53eb25941917f68

See more details on using hashes here.

Provenance

The following attestation bundles were made for scanner_mcp-0.1.1.tar.gz:

Publisher: publish.yml on AminHA1248/scanner-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scanner_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: scanner_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scanner_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e1d313a9e2f18f7abab200e0351a38ae82b25dc36b5ae9117bc30859dd04d04f
MD5 e4657c9b959f76fd2d120472d438a467
BLAKE2b-256 76ba36991c73409a24b892204f1462f9cfb69bf262c5886ce470db14627c5ac6

See more details on using hashes here.

Provenance

The following attestation bundles were made for scanner_mcp-0.1.1-py3-none-any.whl:

Publisher: publish.yml on AminHA1248/scanner-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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