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 and ITINs, 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]

For runnable scripts including a FastMCP server and payload scrubbing, see the examples/ directory.

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

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.9.0
File Size Uploaded
pii_mcp-1.9.0.tar.gz 247.0 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for pii-mcp 1.9.0
File
pii_mcp-1.9.0-py3-none-any.whl Python 3 none any Details
pii_mcp-1.9.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details
pii_mcp-1.9.0-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.9.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.10 abi3 Linux glibc 2.17+ ARM64 Details
pii_mcp-1.9.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details
pii_mcp-1.9.0-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.9.0.tar.gz

Download URL pii_mcp-1.9.0.tar.gz
Size 247.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3979687a0c71237955b96b4fbb6c55ff9a4490f4eb6126d1588102bc29480c3b
BLAKE2b-256 checksum
How to use checksums
101769fe999895a1f4248562c05215da5104a90a27021fd1586dca611c8b573e
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.9.0-py3-none-any.whl

Download URL pii_mcp-1.9.0-py3-none-any.whl
Size 29.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
92c177db4f8cd46163ac6f991d04016b4fb660fc5d7ae4d0680d68edfcb9c1e7
BLAKE2b-256 checksum
How to use checksums
079850fb4bc9123261adeb454a5139a47785ab1fa8df3c3f13f9ea692f6ecb32
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.9.0-cp310-abi3-win_amd64.whl

Download URL pii_mcp-1.9.0-cp310-abi3-win_amd64.whl
Size 805.8 kB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
f959d2f5524d6bad53a1e958804367fb3d1b00c32ee0a4abfe166b79e6eea4c4
BLAKE2b-256 checksum
How to use checksums
e310103f791148562a0173fe281696dbf1882265a1a5ee074751439bc0f1a1c4
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.9.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL pii_mcp-1.9.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 957.5 kB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
842fc2ec05b641ea87d0f42ce2baf3793b28fae4b7b59e56e0ec2b151633dc2e
BLAKE2b-256 checksum
How to use checksums
cf9ad514747e7df112873f9a678d85fcb2cc975d0e865db6a210ee134143b077
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.9.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL pii_mcp-1.9.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 928.7 kB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
c9f87edb9adf4ff3506c53b3972d3df1906fa2f002c44704a86b7490aaff2ff5
BLAKE2b-256 checksum
How to use checksums
3712dc94966da14abe0df780076d922cf22bf6d6744edc536fe1dd4bb4344ac1
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.9.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL pii_mcp-1.9.0-cp310-abi3-macosx_11_0_arm64.whl
Size 836.2 kB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
a242067d718b5edf0a4d533b1465fcc01dbd3feaf24334b4152df478f62195c1
BLAKE2b-256 checksum
How to use checksums
2b615176a8603bc0c6e90ce57bae811635f71eb9f068c72d51d0b16b569b6abb
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.9.0-cp310-abi3-macosx_10_12_x86_64.whl

Download URL pii_mcp-1.9.0-cp310-abi3-macosx_10_12_x86_64.whl
Size 881.8 kB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
3ba8524340a01642b8b97e8f7de6d1f397192ef06be587d8e3031f22f62724e6
BLAKE2b-256 checksum
How to use checksums
4fe7c2bfa7be8ef908623f12dadac820f6c76896e8049c696a068906d29aa507
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

This release

1.9.0 This release

7 release files

1.8.1

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