Skip to main content

pii-mcp

Pattern-based PII scrubbing for MCP servers (regex + checksums), with an optional NER pass for person names in the Rust backend. Masks emails, IBANs, cards, BICs, MACs, IMEIs, IPs, coordinates, BSNs, US SSNs, German tax IDs, Dutch BTW-ids, Dutch passport/ID numbers, phones, street + house number addresses, Dutch and UK postcodes, and Dutch license plates in tool results. Language packs: en, nl, and opt-in de.

PyPI npm CI License: MIT

Example

from pii_mcp import scrub_text

scrub_text(
    "Contact ada@example.com. IBAN NL91 ABNA 0417 1643 00. card 4111111111111111"
)
# Contact [EMAIL]. IBAN [IBAN]. card [CREDIT_CARD]

Install

pip install "pii-mcp[fastmcp]"   # FastMCP >= 3.0.0
# or
pip install pii-mcp              # core; platform wheels include Rust acceleration
# or
npm install pii-mcp

FastMCP

from fastmcp import FastMCP
from pii_mcp.fastmcp import PiiScrubMiddleware

mcp = FastMCP("MyServer")
mcp.add_middleware(PiiScrubMiddleware())  # languages=["en", "nl"] by default
# mcp.add_middleware(PiiScrubMiddleware(languages=["en", "nl", "de"]))

Results only. On scrub failure or oversize, the result is withheld, never forwarded unmasked.

Core

from pii_mcp import scrub_text, scrub_payload

scrub_text("mail ada@example.com")
scrub_payload({"email": "ada@example.com"}, languages=["en"])

Scope

Aligned with AP: wat zijn persoonsgegevens where pattern/checksum detection can reach them. Person names need the opt-in NER build (below). Free-text health data (allergies), photos/audio/video, and unstructured klant-/personeelsnummers stay out of scope.

AP coverage (pattern layer)

AP example / category Detector Notes
e-mail / contact email, phone Incl. Unicode (EAI/IDN) email
IP-adres ip Indirect identifier
Locatiegegevens location Decimal and DMS lat/lon
Financiële gegevens iban, credit_card, bic, vat_id
BSN / nationaal ID bsn, passport Passport/NIK format (nl pack)
Online / device IDs mac, imei IMEI: grouped forms + Luhn
Adres address Street + number; NL/UK postcode
Kenteken license_plate nl pack
Naam person Opt-in NER build only
Pasfoto, allergieën, koopgedrag, camera Media / free text

Person names (optional NER)

ner=True runs an XLM-R token classifier (Davlan/xlm-roberta-base-ner-hrl, AFL-3.0; EN/NL/DE among its languages) after the pattern detectors and masks person names as [PERSON]. It runs in the Rust core on candle (CPU, fp32) and is off by default: published wheels and the npm package are built without it, and no weights ship with any package.

Build with the ner feature:

maturin develop --release --features ner                  # Python
(cd typescript && npm run build:native -- --features ner) # Node
cargo build -p pii-core --features ner                    # Rust

Download the pinned weights (1.1 GB) and the matching XLM-R tokenizer (MIT) into one directory, and point PII_MCP_NER_MODEL at it:

mkdir -p ner-model && cd ner-model
M=https://huggingface.co/Davlan/xlm-roberta-base-ner-hrl/resolve/253f557bd8249b8515114cfd7f71974fe5fa4d2f
T=https://huggingface.co/FacebookAI/xlm-roberta-base/resolve/e73636d4f797dec63c3081bb6ed5c7b0bb3f2089
curl -fL -O "$M/config.json" -O "$M/model.safetensors" -O "$T/tokenizer.json"
export PII_MCP_NER_MODEL="$PWD"
scrub_text("Mail Ada Lovelace at ada@example.com", ner=True)
# {'text': 'Mail [PERSON] at [EMAIL]', ...}
  • Pattern hits are masked first; the NER pass never re-tags a placeholder, so nothing is counted twice.
  • PII_MCP_NER_THRESHOLD (default 0.9) is the minimum person probability per token. The default favors precision; lower it (for example 0.5) to mask more names at the cost of more false positives.
  • ner=True raises PiiScrubError when the build has no ner feature, the backend is pure Python / TypeScript, or the model directory is missing or invalid. Text is never returned with the NER pass silently skipped.

Cost on macOS arm64 (M4 Pro), scripts/bench_backends.py with PII_MCP_NER_MODEL set:

Case Regex only ner=True
Short mixed PII 0.028 ms 67 ms
2 KiB tool result 0.22 ms 532 ms
16 KiB tool result 2.3 ms 4.6 s

Inference time grows with input length, at about 0.3 s per KiB here: a 1 MiB tool result takes about 5 minutes. Use ner=True for results of a few KiB, not for bulk text. Model load takes 2.0 s once per process; peak RSS is about 2.4 GB. Inference is fp32 only: candle's XLM-R implementation builds its attention mask in F32, so fp16 weights do not run.

On the eval (PII_MCP_NER_MODEL=<dir> python eval/score.py --ner, EN/NL/DE names in 15 contexts), person scores recall 0.987 and precision 0.931. Most false positives are company names such as Albert Heijn. The address generators only produce the street shapes the patterns support, so the address recall of 1.0 covers those shapes only; precision is measured with the en, nl and de packs against bare street names and company names. Words that end in a street suffix and are followed by a number (Keypad 3, Supermarkt 24) are masked on purpose, since dropping those suffixes leaks real addresses such as Nieuwmarkt 4.

Packages

Runtime Path Install
Python src/pii_mcp pip install pii-mcp
TypeScript typescript/ npm install pii-mcp
Rust core crates/pii-core shared by both (PyO3 / N-API)

Rust core (Python)

Published platform wheels ship pii_mcp._native (PyO3 over pii-core). Pip prefers those on supported OS/arch; elsewhere (or with --no-binary) you get the pure-Python hatchling wheel/sdist and the same scrub API.

When _native is importable, scrub_text / scrub_payload use it. Force the Python path with PII_MCP_BACKEND=python; require native with PII_MCP_BACKEND=native.

Local development from a clone (optional):

pip install -e ".[native]"
maturin develop --release --manifest-path crates/pii-mcp-native/Cargo.toml

Performance (Python vs Rust release)

Medians from scripts/bench_backends.py on macOS arm64 / CPython 3.14.7 (release native build; debug builds are not representative):

Case Python Rust Speedup
Short clean text 0.234 ms 0.023 ms 10.2x
Short mixed PII 0.058 ms 0.007 ms 8.9x
100 KiB sparse PII 20.4 ms 2.0 ms 10.2x
1 MiB sparse PII 203 ms 20.4 ms 10.0x
Nested JSON payload 12.4 ms 1.2 ms 10.3x
1k x tiny scrub_text 54.3 ms 6.8 ms 8.0x
python scripts/bench_backends.py

Metadata

Release files for pii-mcp 1.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pii-mcp 1.8.1
File Size Uploaded
pii_mcp-1.8.1.tar.gz 243.0 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for pii-mcp 1.8.1
File
pii_mcp-1.8.1-py3-none-any.whl Python 3 none any Details
pii_mcp-1.8.1-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details
pii_mcp-1.8.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.10 abi3 Linux glibc 2.17+ x86-64 Details
pii_mcp-1.8.1-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.10 abi3 Linux glibc 2.17+ ARM64 Details
pii_mcp-1.8.1-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details
pii_mcp-1.8.1-cp310-abi3-macosx_10_12_x86_64.whl CPython 3.10 abi3 macOS 10.12+ x86-64 Details

Total release size: 4.7 MB

Release files / pii_mcp-1.8.1.tar.gz

Download URL pii_mcp-1.8.1.tar.gz
Size 243.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3b9744cd44ae360c7eacd526238517259665d77f3f95398029eca33e9c0c81b6
BLAKE2b-256 checksum
How to use checksums
a678c82b447d516dc722337400d70effb7ccbeae09071f5e8b8c26599d1e6856
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / pii_mcp-1.8.1-py3-none-any.whl

Download URL pii_mcp-1.8.1-py3-none-any.whl
Size 28.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b92fd4282bc21a0b6433b45f973cd8b8283c3c19475b506410cb299b3b074afc
BLAKE2b-256 checksum
How to use checksums
2ed4d3880c2d8e353004d56acbe451c3f09ce4ef4afd985b1c471881cbc8bfb1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / pii_mcp-1.8.1-cp310-abi3-win_amd64.whl

Download URL pii_mcp-1.8.1-cp310-abi3-win_amd64.whl
Size 803.7 kB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
621fd5625a2f22583e3d881cb94b62f9c79eab6c9a89d5d2d6930873203fddfe
BLAKE2b-256 checksum
How to use checksums
cfc4d273d1a4ab8ff3ee5e0298deb83e619d1f654ce18d7c0dfc894e11adbb41
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / pii_mcp-1.8.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL pii_mcp-1.8.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 955.3 kB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
4265f5273a08afcb281f7cd60cbde199c09fca37a987a98592bac23c6b2a16c2
BLAKE2b-256 checksum
How to use checksums
896528367e5ac2e2bf5a80b6e9d62ff7a9e318f49249b7b050d5d236ee14b562
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / pii_mcp-1.8.1-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL pii_mcp-1.8.1-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 926.0 kB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
2a620bde874f1642e70d46e795e2c66d927401d907b6e2e1b33943de6c536457
BLAKE2b-256 checksum
How to use checksums
f833bc91cc76ec4e863d5ae9c92256407934277d4f20a2542c7272d97aec1639
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / pii_mcp-1.8.1-cp310-abi3-macosx_11_0_arm64.whl

Download URL pii_mcp-1.8.1-cp310-abi3-macosx_11_0_arm64.whl
Size 833.1 kB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
b3fe5c7f240713f9177c745856154507c8cc0d5eb6da369bbcedf7a2415e85d8
BLAKE2b-256 checksum
How to use checksums
1a97aad2a4aca87ffe0b4c5ae9b9b1aacbfd3021bce0b571ca0e0dcbf522a444
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / pii_mcp-1.8.1-cp310-abi3-macosx_10_12_x86_64.whl

Download URL pii_mcp-1.8.1-cp310-abi3-macosx_10_12_x86_64.whl
Size 879.6 kB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
c79b7b13116943a5cbb71e5118716d84db04610bf55ab5aab675d5ffaa46692f
BLAKE2b-256 checksum
How to use checksums
fc00c4fd3f1b098fe9fd7287f24dbaa66e8733c11bae875205cf092196619813
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release history Release notifications | RSS feed

1.10.0

7 release files

1.9.1

7 release files

1.9.0

7 release files

This release

1.8.1 This release

7 release files

1.8.0

7 release files

1.7.1

7 release files

1.7.0

7 release files

1.6.0

7 release files

1.5.5

7 release files

1.5.4

7 release files

1.5.3

7 release files

1.5.2

7 release files

1.5.1

7 release files

1.5.0

7 release files

1.4.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page