Skip to main content
Glama
securedact-mcp

securedact-mcp

SecuRedact MCP

PyPI Python License: Apache-2.0

SecuRedact ist eine lokale Datenschutz- und Sicherheitsebene für KI-Agenten und KI-Workflows. Es erkennt und schützt sensible Daten – personenbezogene Daten / PII, DSGVO-relevante Informationen, Anmeldedaten, API-Schlüssel, Tokens, Geheimnisse und sensible Dateien – bevor diese Daten Modelle, Tools, Dateien oder externe Ziele erreichen.

SecuRedact MCP ist der unter Apache-2.0 lizenzierte Open-Source-MCP-Server und die wiederverwendbare Python-Datenschutz-Engine. Es erkennt sensiblen Text, wendet versionierte Richtlinien an, schwärzt lokal und validiert die Restausgabe, bevor der bereinigte Inhalt als genehmigt markiert wird.

Der MCP-Modus fängt nicht automatisch jede Eingabeaufforderung ab. Der Host muss das Tool aufrufen und nur sanitized_text senden, wenn status == "ok" ist; ein falsch konfigurierter oder bösartiger MCP-Host kann diesen normalen MCP-Workflow umgehen. Vom Anbieter native erzwungene Hooks sind separate Integrationsressourcen: Wenn ein unterstützter Anbieter einen solchen Hook an seiner Prompt-Lebenszyklus-Grenze aufruft, kann er dieselbe deterministische Entscheidung vor der normalen Modellverarbeitung anwenden. Siehe SecuRedact Enforced.

Warum SecuRedact

KI-Agenten lesen zunehmend Dateien, rufen Tools auf und senden Prompts an externe Modelle. Das setzt PII, Anmeldedaten und sensible Dokumente offen, es sei denn, etwas prüft die Daten zuerst. SecuRedact ist eine Datenschutz- und Sicherheitskontrolle für KI-Workflows:

  • Lokal zuerst – alle Erkennungs-, Schwärzungs- und Richtlinienbewertungen laufen auf Ihrem Rechner. Standardmäßig kein Netzwerk-Listener, keine Telemetrie, keine Anbieteraufrufe.

  • PII-/DSGVO-Erkennung – Namen, E-Mails, IBANs, Kennungen und Daten besonderer Kategorien werden erkannt und pseudonymisiert oder geschwärzt.

  • Schutz von Geheimnissen und Anmeldedaten – API-Schlüssel, Tokens und Passwörter werden erkannt und daran gehindert, Ihre Umgebung zu verlassen.

  • Dateisystemschutz – Lesezugriffe werden gegen Traversal-/Symlink-Escapes verteidigt und vor geschützten Pfaden wie .env blockiert.

  • KI-Agenten-Datenschutz-Firewall – erzwungene Hooks für Claude Code und Gemini CLI führen dieselbe lokale Entscheidung aus, bevor ein Prompt, ein Modellaufruf oder eine Tool-Aktion fortgesetzt wird.

  • Netzwerk-/Egress-Bewusstsein – ausgehende Tool-Aufrufe werden klassifiziert (intern/extern/unbekannt), sodass Richtlinien eine Genehmigung verlangen oder Egress blockieren können.

SecuRedact hilft, die Offenlegung sensibler Daten zu reduzieren; es ist keine Garantie für Compliance oder eine Behauptung, dass jedes Leck verhindert wird. Siehe Einschränkungen.

Related MCP server: phi-redact-mcp

Schnellstart

Installieren Sie von PyPI und führen Sie die geführte Einrichtung aus (Windows):

py -3.12 -m pip install "securedact-mcp[ml]"
securedact-mcp setup

Linux / macOS:

python3.12 -m pip install "securedact-mcp[ml]"
securedact-mcp setup

Schützen Sie in Sekunden einen Text (nur deterministische Demo, kein Modell erforderlich):

import os

os.environ["SECUREDACT_REQUIRE_FLAIR"] = "0"  # deterministic detectors only
from securedact_core import RedactionRequest, SecuredactEngine

engine = SecuredactEngine.from_environment()
result = engine.prepare(
    RedactionRequest(
        text="Contact alex@example.test, IBAN NL91ABNA0417164300",
        policy="strict_external_ai",
    )
)
print(result.status)  # "ok"
print(result.sanitized_text)  # "Contact [EMAIL_1], IBAN [IBAN_1]"

Reproduzierbare synthetische Sicherheits-Demos: docs/distribution/security-demo.md.

Sicherer Standard-Workflow

Verwenden Sie prepare_for_external_ai für die normale Vorbereitung externer KI:

{
  "text": "Contact alex@example.test",
  "policy": "strict_external_ai",
  "language": "auto",
  "response_mode": "minimal"
}

Genehmigte Antwort:

{
  "schema_version": "1",
  "status": "ok",
  "sanitized_text": "Contact [EMAIL_1]",
  "counts": {"email": 1},
  "policy": "strict_external_ai",
  "policy_version": 1,
  "policy_digest": "...",
  "reason_codes": []
}

review_required- und blocked-Antworten enthalten niemals genehmigtes sanitized_text. Minimale Antworten enthalten keinen Originaltext, keine Rohwerte von Entitäten, keine Zuordnungen, keinen Ausnahmetext, keinen Stack-Trace, keinen Modellpfad und keinen Wiederherstellungs-Handle, es sei denn, restore_capable wurde explizit ausgewählt.

Architektur und Vertrauensgrenze

flowchart LR
    H["MCP host"] --> M["Securedact MCP"]
    M --> D["deterministic detectors"]
    M --> C["contextual detectors"]
    D --> P["policy engine"]
    C --> P
    P --> R["redactor"]
    R --> V["residual validator"]
    V --> O["approved sanitized output"]
    O --> W["host-controlled downstream workflow"]
    H -. "host may bypass MCP" .-> W

Der Server hat keine Anbieter-Clients, keinen OpenAI-kompatiblen Proxy, keinen Reverse-Proxy, keine Website, keinen Desktop-Chatbot, keine Anbieter-Anmeldedaten und keine anbieterspezifische Weiterleitung. Siehe ADR 0001 und das Bedrohungsmodell.

Tools

Tool

Verwendungszweck

Verhalten bei sensiblen Antworten

prepare_for_external_ai

Empfohlener vollständiger sicherer Workflow

Standardmäßig minimal

analyze_text

Niedrigere lokale Analyse/Überprüfung

Minimal; Offsets in review; Rohwerte nur im aktivierten Debug-Modus

redact_text

Niedrigere Kompatibilitätsoperation

Standardmäßig minimal; expliziter legacy-Modus ist sensibel und veraltet

restore_text

Verbraucht eine lokale undurchsichtige Sitzung

Standardmäßig einmalig; direkte Zuordnungen erfordern expliziten vertrauenswürdigen Legacy-Modus

create_safe_copy

Schreibt genehmigte .txt/.md-Inhalte unter einem konfigurierten Stammverzeichnis

Gibt keine Zuordnung oder keinen absoluten Pfad zurück

securedact_read_file

Liest sicher eine lokale Datei und gibt nur bereinigten Text zurück

Blockiert geschützte Pfade vor dem Lesen; lehnt Traversal/Symlink/Binärdateien ab; standardmäßig minimal

Antwortmodi sind minimal, review, debug und restore_capable. Debug ist deaktiviert, es sei denn, der Prozess wurde mit SECUREDACT_ENABLE_DEBUG_RESPONSES=1 gestartet; eine MCP-Anfrage kann es nicht aktivieren. In-Memory-Wiederherstellungssitzungen verwenden kryptografische Zufalls-Handles, begrenzte Kapazität, Ablauf, Parallelitätsschutz und einmaligen Verbrauch. Der Prozessende zerstört alle Sitzungen.

Siehe MCP-Tools, Antwort-Datenschutz und Wiederherstellungssitzungen.

Installation

Python >=3.12,<3.13 wird unterstützt.

Für eine normale Installation von PyPI:

py -3.12 -m pip install "securedact-mcp[ml]"
securedact-mcp setup

Unter Linux oder macOS verwenden Sie python3.12 -m pip install "securedact-mcp[ml]"; python -m pip install "securedact-mcp[ml]" ist ebenfalls geeignet, wenn python bereits eine unterstützte 3.12-Umgebung auswählt.

setup prüft das Paket, Python- und ML-Abhängigkeiten, inspiziert den lokalen Modellzustand, bietet den bestehenden zustimmungsbasierten Modellinstaller an, führt den bestehenden Offline-Verifier aus und bietet die paketierten Claude Code- und Gemini CLI-Integrationen an, wenn diese Hosts erkannt werden. Es verwendet die offiziellen Plugin-/Erweiterungsbefehle der Anbieter und kann sicher erneut ausgeführt werden. Es ruft keine Anbieter-Modell-API auf, akzeptiert keine Anbietervertrauen automatisch und lädt kein kontextuelles Modell herunter, es sei denn, der Benutzer wählt explizit die Modelleinrichtung aus und akzeptiert die bestehende Upstream-Eingabeaufforderung.

Manuelle Modellbefehle bleiben für fortgeschrittene oder unbeaufsichtigte Operationen verfügbar:

securedact-mcp install
securedact-mcp models verify
securedact-mcp

Der letzte Befehl startet einen lokalen stdio-Server. Die Standardausgabe ist für MCP-Protokollnachrichten reserviert. securedact-mcp setup --non-interactive meldet den Zustand, ohne eine Upstream-Akzeptanz zu implizieren oder einen neuen Anbieter zu konfigurieren. Verwenden Sie --host claude, --host gemini oder --host all für gezielte interaktive Anbietereinrichtung.

Entwickler-/Quellinstallation

Um stattdessen von einem überprüften Quell-Checkout zu arbeiten:

git clone https://github.com/GigantesHJI/securedact-mcp.git
cd securedact-mcp
python -m pip install ".[ml]"
securedact-mcp setup

Kein Modell-Checkpoint ist im Repository oder Wheel enthalten, und der Start lädt niemals einen herunter. Securedact verteilt diese Modellgewichte nicht weiter. Upstream-Modellgewichte behalten ihre eigenen Lizenzen und werden nicht durch Apache-2.0 neu lizenziert. Siehe Modellinstallation und Drittanbieter-Lizenzen.

Die rein deterministische lokale Entwicklung muss explizit ausgewählt werden:

$env:SECUREDACT_REQUIRE_FLAIR = "0"
securedact-mcp

Die Produktion erfordert standardmäßig kontextuelle Fähigkeiten und schlägt fehl, während ein konfiguriertes Modell fehlt, lädt, beschädigt oder nicht verfügbar ist.

Host-Pakete

Getestete Konfigurationsressourcen und Anweisungen für sichere Workflows finden Sie unter integrations/ für Codex, Cursor und Windsurf. Die automatisierte MCP-Client-Testumgebung validiert Serverstart, Tool-Auflistung, Aufrufe, minimale Antwortform, stdout-Integrität und Herunterfahren. Sie beweist nicht, dass ein echter Host das Tool für jeden Prompt aufruft. Siehe den Kompatibilitätsnachweis.

Das Repository ist auch eine Gemini-CLI-Erweiterungswurzel: gemini extensions install https://github.com/GigantesHJI/securedact-mcp kann die Hooks installieren. Das Thema gemini-cli-extension und ein Release, dessen Tag-Baum das Wurzelmanifest enthält, sind erforderlich, damit dieser Pfad aufgelöst wird; ohne pip install "securedact-mcp[ml]" und die lokalen Modelle erzwingen die installierten Hooks nichts. Siehe SecuRedact Enforced.

Richtlinien und Python-API

Integrierte Richtlinien umfassen default, strict_external_ai, gdpr, identifiers_only und review_all_contextual; Kompatibilitätsrichtlinien bleiben verfügbar. Lokale Organisationsrichtliniendateien werden nur aus dem kontrollierten Richtlinienverzeichnis geladen, verwenden ein strenges deklaratives Schema und können Fail-Closed-Invarianten nicht deaktivieren. Unbekannte, doppelte, überdimensionierte, fehlerhafte oder symbolisch verknüpfte Richtlinien schlagen fehl.

from securedact_core import RedactionRequest, SecuredactEngine

engine = SecuredactEngine.from_environment()
result = engine.prepare(
    RedactionRequest(
        text="Contact alex@example.test",
        policy="strict_external_ai",
    )
)

from_environment() erhält die Anforderung des kontextuellen Modells. Die eigenständige deterministische Entwicklung erfordert SECUREDACT_REQUIRE_FLAIR=0; Anwendungen können auch getestete Detektorimplementierungen injizieren. Siehe öffentliche API und Richtlinien.

Reproduzierbare Entwicklung

Die festgeschriebene uv.lock löst Laufzeit-, ML-, Entwicklungs-, Benchmark- und Sicherheits-Extras für Python 3.12 auf.

uv sync --frozen --extra dev --extra benchmark
uv run python scripts\verify.py

Verwenden Sie niemals echte persönliche Informationen, private Dokumente, Anmeldedaten, Kundenprotokolle oder Modellgewichte in Tests, Issues, Screenshots, Fixtures oder Pull-Requests. Siehe CONTRIBUTING.md.

Bewertung und Leistung

uv run python -m securedact_eval quality --mode deterministic --gate `
  --thresholds benchmarks\thresholds.json `
  --baseline benchmarks\baselines\quality-deterministic.json
uv run python -m securedact_eval performance --mode deterministic

Das versionierte synthetische Korpus berichtet exakte und relaxierte Span-Präzision, Recall, F1, False-Positive- und False-Negative-Raten, Ergebnisse pro Entität/Sprache/Domäne/Split, Aktions-/Kategoriegenauigkeit und Bootstrap-Recall-Intervalle. Echte Negative sind dokumentebene negative Beispiele, keine Token-Ebene-Sicherheit. Die DSGVO-bezogene Suite ist eine Erkennungsbewertung, keine rechtliche Compliance-Zertifizierung. Echte Flair- und GPU-Benchmarks erfordern ein explizit konfiguriertes lokales Modell und sind kein gewöhnliches CI. Siehe Benchmarking. Das Benchmark-Framework dokumentiert lokale Datenschichten und große Profile; der Migrationsplan definiert seine zukünftige Extraktionsgrenze. Für einen Fehler vor der Ausführung von Repository-Schritten durch GitHub verwenden Sie den CI-Fehlerbehebungs-Entscheidungsbaum. Lokaler Erfolg ersetzt keinen erforderlichen GitHub-Check.

Sicherheit und Einschränkungen

  • Kein Prompt, kein Befund, keine Zuordnung, kein Wiederherstellungs-Handle, kein Geheimnis, keine Modelleingabe und keine wiederhergestellte Ausgabe wird vom Anwendungscode protokolliert.

  • Deterministische und kontextuelle Erkennung kann neuartige, mehrdeutige oder adversariale Offenlegung übersehen; Koreferenz und universelle Verschleierungsresistenz werden nicht beansprucht.

  • Überprüfungsoffsets ermöglichen einem vertrauenswürdigen lokalen Client mit der ursprünglichen Eingabe, einen Wert zu rekonstruieren; halten Sie Überprüfungsantworten lokal.

  • Host-Verhalten und nachgelagertes Anbieterverhalten liegen außerhalb der Vertrauensgrenze.

  • In Dateien dokumentierte Repository-Sicherheitseinstellungen erfordern weiterhin eine Administratorüberprüfung.

Melden Sie Schwachstellen privat über SECURITY.md. Geben Sie keine Schwachstellendetails oder echten Daten in ein öffentliches Issue.

Lizenz

Der ursprüngliche Repository-Quellcode und die Dokumentation sind unter der Apache License 2.0 lizenziert. Die Urheberrechtszuordnung ist in NOTICE festgehalten. Drittanbieterabhängigkeiten und Modellgewichte behalten ihre eigenen Lizenzen.

Available Tools

6 tools
analyze_textA
Read-onlyIdempotent

Inspect text locally and report detected sensitive content without producing sanitized output.

Use this when you need to understand what PII, secrets, or credentials are present (counts, entity types, and, with review/debug modes, positions) but do not need redacted text for transmission. The original text is not modified and no sanitized representation is returned. For a policy-approved, ready-to-send result use prepare_for_external_ai; for a sanitized file use create_safe_copy; for reversing a prior local session use restore_text.

Returns a JSON object with 'status' ('ok', 'review_required', or 'blocked'), 'policy', 'policy_version', 'policy_digest', 'counts' (entity-type tallies), and, when response_mode is 'review' or 'debug', a 'findings' list. 'debug' additionally returns 'debug_details'.

Inputs: text (required), policy, response_mode. Returns: object

create_safe_copyA

Sanitize text locally and write the approved result to a new file in the Safe Copies directory.

Use this when you need a sanitized on-disk copy (for storage, handoff, or archival) rather than an in-memory sanitized string. For the sanitized text only, use prepare_for_external_ai; for inspection-only use analyze_text; for reversing a prior session use restore_text.

Side effects: a new file is written to the directory set by SECUREDACT_SAFE_COPY_DIR. The supplied 'content' is not modified and no existing file is overwritten. The filename must be a bare '.txt' or '.md' basename (no path separators or directory traversal). The operation blocks and reports 'blocked' if the directory is unconfigured, the filename is invalid, or policy blocks the content.

Returns a JSON object with 'status' ('ok' or 'blocked'), 'filename', and 'counts'.

Inputs: content (required), filename (required), policy. Returns: object

prepare_for_external_aiA
Read-onlyIdempotent

Use this before sending user-supplied or potentially sensitive text to an external AI service.

SecuRedact inspects and sanitizes the text locally and returns the policy-approved representation; this tool does not transmit the text externally. It is the recommended default for outbound AI workflows. Use analyze_text for inspection-only classifications, redact_text for the lower-level compatibility path, create_safe_copy when a sanitized file is required, and restore_text only to reverse a prior local session in a trusted context.

Returns a JSON object with 'status' ('ok', 'review_required', or 'blocked'), 'sanitized_text' (present only when approved), 'counts', 'policy', and optionally 'restoration_session' (when response_mode is 'restore_capable').

Inputs: text (required), policy, language, response_mode. Returns: object

redact_textA
Read-onlyIdempotent

Direct/lower-level redaction entry point; prefer prepare_for_external_ai for normal outbound workflows.

In its normal modes this performs the same local sanitization as prepare_for_external_ai and returns the approved result, so most agents should call prepare_for_external_ai instead. Use redact_text when you specifically need this lower-level compatibility path, or the 'legacy' mode for local review of raw redaction internals. The 'legacy' mode returns potentially sensitive local-review details and is never selected by default.

Returns, for normal modes, the same approved result as prepare_for_external_ai (status, sanitized_text, counts). For 'legacy' mode it returns a result with deprecation_code 'legacy_sensitive_response' containing local-review redaction data.

Inputs: text (required), policy, response_mode. Returns: object

restore_textA

Reverse a prior SecuRedact protection step in a trusted, local-only context.

Use this ONLY after you previously received a restoration_session from SecuRedact (for example from prepare_for_external_ai with response_mode 'restore_capable') and now need to reconstruct the original text locally for trusted review. Restoration can reveal the original sensitive values (PII, secrets, credentials); it is a trusted-local operation, not a step to prepare data for external transmission. Never call it to sanitize or prepare text for an external AI; for that use prepare_for_external_ai. Never call it on text you did not previously protect with SecuRedact.

Security boundary: all processing is local and nothing leaves the machine. The 'mapping' form requires trusted_local_review=true and exposes raw originals, so its output must never be transmitted. Returns a JSON object with 'status' ('ok' or 'blocked'), 'restored_text' (present only on success), and 'reason_codes' describing any failure.

Inputs: text (required), mapping, restoration_session, trusted_local_review. Returns: object

securedact_read_fileA
Read-onlyIdempotent

Safely read a local file and return only its sanitized (PII/secrets removed) text.

Use this when you must ingest a local file's contents for use with an external AI but want path-traversal, size, and binary defenses plus sanitization applied first. If the content is already in memory, use prepare_for_external_ai; for a sanitized file on disk, use create_safe_copy.

Side effects: reads a file from local disk and never transmits it. Sensitive paths and escapes are blocked before any file content is read. The returned 'sanitized_text' is safe to forward.

Returns a JSON object with 'status' ('ok' or 'blocked'), 'path', and 'sanitized_text' (present only when approved).

Inputs: path (required), policy, max_bytes. Returns: object

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4.5/5.0

    Scored across 6 tools

    Disambiguation4/5

    Most tools have clearly distinct outputs (in-memory text, file write, file read, inspection, restoration), but prepare_for_external_ai and redact_text perform identical sanitization in normal modes, with redact_text explicitly deferring to prepare_for_external_ai. This creates a potential misselection point despite the helpful cross-references.

    Naming Consistency4/5

    The majority of tools follow a clean verb_noun pattern (analyze_text, redact_text, restore_text, create_safe_copy). prepare_for_external_ai and securedact_read_file deviate with a prepositional phrase and a brand prefix, but the overall naming remains readable and predictable.

    Tool Count5/5

    Six tools is well within the ideal scope for a focused sanitization server. Each tool maps to a distinct workflow step, and none feel extraneous enough to bloat the surface.

    Completeness4/5

    The set covers the core lifecycle: inspection, in-memory sanitization, safe file output, safe file input, and session restoration. Minor gaps exist around policy management and the redundant redact_text path, but there are no critical dead ends for the stated purpose.

    Maintenance

    ActivityStale
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      C
      maintenance
      An MCP server that redacts PII/PHI from text before it ever reaches an LLM — self-hosted, fail-closed, and HIPAA-aware.
      3
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      MCP server providing on-prem PII detection and anonymization tools (scan and is_sensitive) for AI agents, ensuring data stays local.
      4
      MIT
    • F
      license
      A
      quality
      B
      maintenance
      MCP server for local, verifiable PDF redaction. Enables AI agents to find sensitive regions, locate text, redact PDFs on-device, verify redaction and tamper-evidence seals, and generate PDFs—without uploading confidential documents.
      8
      629 npm
      -