@privacyscrubber/mcp-server 2.0.3 → 2.2.0

package/README.md

@@ -2,11 +2,16 @@
 
 [![NPM Version](https://img.shields.io/npm/v/@privacyscrubber/mcp-server?color=blue)](https://www.npmjs.com/package/@privacyscrubber/mcp-server)
 [![NPM Downloads](https://img.shields.io/npm/dm/@privacyscrubber/mcp-server?color=3b82f6)](https://www.npmjs.com/package/@privacyscrubber/mcp-server)
+[![NPM SDK](https://img.shields.io/npm/v/@privacyscrubber/sdk?label=%40privacyscrubber%2Fsdk&color=10b981)](https://www.npmjs.com/package/@privacyscrubber/sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22058770.svg)](https://zenodo.org/records/22058770)
 [![OSF DOI](https://img.shields.io/badge/OSF%20DOI-10.17605%2FOSF.IO%2F5BYJF-blue.svg)](https://osf.io/5byjf/)
 [![SSRN](https://img.shields.io/badge/SSRN-7335581-darkred.svg)](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=7335581)
 [![smithery badge](https://smithery.ai/badge/privacyscrubber/pii-masking-mcp)](https://smithery.ai/servers/privacyscrubber/pii-masking-mcp)
+[![Cursor Directory](https://img.shields.io/badge/Cursor%20Directory-Verified%20Plugin-000000.svg)](https://cursor.directory/plugins/privacyscrubber-mcp)
+[![Glama.ai](https://glama.ai/mcp/servers/moxno/privacyscrubber-mcp/badge)](https://glama.ai/mcp/servers/moxno/privacyscrubber-mcp)
+[![TensorBlock MCP Index](https://img.shields.io/badge/TensorBlock-Indexed%20MCP-FF6B6B.svg)](https://github.com/TensorBlock/awesome-mcp-servers)
+[![There's An AI For That](https://img.shields.io/badge/There's_An_AI_For_That-Live-06b6d4.svg)](https://theresanaiforthat.com/ai/privacy-scrubber/)
 [![Security: 100% Local](https://img.shields.io/badge/Security-100%25%20Local-emerald)](https://privacyscrubber.com)
 [![Parity: 100% Core Match](https://img.shields.io/badge/Parity-100%25%20Core%20Match-blueviolet)](https://privacyscrubber.com)
 
@@ -43,6 +48,23 @@ Run the server directly without local installation:
 npx -y @privacyscrubber/mcp-server
 ```
 
+### 3. Programmatic Node.js / TypeScript SDK
+Need direct, in-memory zero-trust PII sanitization in your backend microservice or custom AI agent rather than an MCP server? Use our official zero-dependency SDK:
+
+```bash
+npm install @privacyscrubber/sdk
+```
+
+```javascript
+import OpenAI from 'openai';
+import { wrapOpenAI } from '@privacyscrubber/sdk';
+
+// Transparently masks PII before sending to LLM and rehydrates responses:
+const openai = wrapOpenAI(new OpenAI({ apiKey: process.env.OPENAI_API_KEY }));
+```
+
+👉 [View @privacyscrubber/sdk on NPM](https://www.npmjs.com/package/@privacyscrubber/sdk) | Includes `wrapOpenAI()` middleware, TypeScript definitions, and 25 compliance profiles.
+
 ---
 
 ## ⚙️ Client Integrations
@@ -74,6 +96,28 @@ Add this to your Claude Desktop config file:
     *   **Command:** `npx -y @privacyscrubber/mcp-server`
 3. Optional: Set `PRIVACYSCRUBBER_KEY` as an environment variable in your system shell.
 
+### Cline / Roo Code
+Add to `cline_mcp_settings.json`:
+```json
+{
+  "mcpServers": {
+    "privacyscrubber": {
+      "command": "npx",
+      "args": ["-y", "@privacyscrubber/mcp-server"],
+      "env": {
+        "PRIVACYSCRUBBER_KEY": "YOUR_OPTIONAL_PRO_LICENSE_KEY"
+      }
+    }
+  }
+}
+```
+
+### Claude Code CLI
+Add directly from your terminal:
+```bash
+claude mcp add privacyscrubber -- npx -y @privacyscrubber/mcp-server
+```
+
 ---
 
 ## 🛠️ Provided Tools & JSON-RPC Specifications
@@ -145,35 +189,47 @@ Reads a local file, extracts text, sanitizes it, and returns the redacted templa
     *   `filePath` (string, required): Absolute file path to read and sanitize.
     *   `profile` (string, optional): The industry detection profile.
 
----
+### 4. `guard_exec` (Command Execution Firewall)
+Safely executes terminal commands in an isolated child process, masking stdout/stderr PII, database credentials, and API keys in local RAM before passing them to the AI agent. Includes a CISO audit receipt in stderr.
 
-## 🌐 Browser Extension & Web Client
+*   **Arguments:**
+    *   `command` (string, required): The shell command to execute (e.g. `cat .env`, `docker logs web`, `git diff`).
+    *   `cwd` (string, optional): Working directory.
+    *   `profile` (string, optional): Detection profile (defaults to `Dev`).
+    *   `timeout_ms` (number, optional): Timeout in ms (defaults to `15000`).
 
-Looking for real-time protection directly inside your web browser?
-*   **Chrome Extension:** Get the [PrivacyScrubber Chrome Extension](https://chromewebstore.google.com/detail/privacyscrubber-%E2%80%94-pii-red/pimoejgefeilajmmbpghifdmhdlkgjol) to sanitize prompts directly inside ChatGPT, Claude, and Gemini in real-time.
-*   **Web Sandbox:** Use the zero-server browser sanitization tools at [PrivacyScrubber Homepage](https://privacyscrubber.com/?utm_source=npm&utm_medium=readme&utm_campaign=mcp_server).
+### 5. `guard_read_file` (Credential-Masking File Reader)
+Reads files (.env, configs, source code, database dumps) and tokenizes all passwords, JWTs, and PII in volatile memory, returning safe redacted content for AI reasoning.
 
-## 📄 License & Commercial Upgrade
+*   **Arguments:**
+    *   `file_path` (string, required): Path to file.
+    *   `profile` (string, optional): Detection profile (defaults to `Dev`).
+    *   `max_lines` (number, optional): Line cap for large files (defaults to `500`).
 
-By default, the server runs under the **Free Tier** (restricted to 50,000 characters per request and the basic `General` PII profile). To unlock advanced engineering, medical, legal, and financial PII profiles, as well as team-wide custom rules, you can purchase a commercial license.
+### 6. `guard_git_diff` (Pre-Commit & Diff Sanitizer)
+Inspects staged (`--cached`) or unstaged repository diffs, redacting any newly introduced secrets or PII in local RAM before AI code review or commit message generation.
 
-### Feature Comparison
+*   **Arguments:**
+    *   `staged` (boolean, optional): If `true`, inspects staged changes (`git diff --cached`). Defaults to `false`.
+    *   `cwd` (string, optional): Working directory.
+    *   `profile` (string, optional): Detection profile (defaults to `Dev`).
 
-| Feature | Free Tier | PRO Tier | TEAMS Tier |
-| :--- | :--- | :--- | :--- |
-| **Volatile Tokenization** | ✅ Yes | ✅ Yes | ✅ Yes |
-| **Standard PII Masking** | ✅ Yes | ✅ Yes | ✅ Yes |
-| **Max Character Length** | 50,000 chars | ♾️ Unlimited | ♾️ Unlimited |
-| **Industry Profiles** | General Only | 22+ Profiles | 22+ Profiles |
-| **Custom Regex Rules** | ❌ Locked | ♾️ Unlimited | ♾️ Unlimited |
-| **Team Rules Sync (GPO)** | ❌ No | ❌ No | ✅ Yes (Shared Link) |
-| **Licensing Cost** | $0 | **$110 Lifetime** | **$99/mo Flat Rate** |
+### 7. `guard_apply_patch` (Safe Patch Applicator)
+Reverses token placeholders (`[API_KEY_1]`, `[SECRET_1]`) in AI-generated code or text by looking up the local RAM session map, creating a `.bak` backup, and writing authentic cleartext directly to disk. The remote LLM never sees real secrets.
 
-👉 **[Acquire a PRO / TEAMS License Key at privacyscrubber.com/pricing](https://privacyscrubber.com/pricing?utm_source=npm&utm_medium=readme&utm_campaign=mcp_server)**
+*   **Arguments:**
+    *   `file_path` (string, required): Path to target file.
+    *   `content` (string, required): Content containing tokens to restore on disk.
+    *   `create_backup` (boolean, optional): Backup existing file before write (defaults to `true`).
 
----
+### 8. `create_agent_rules` (1-Click Agent Rule Injection)
+Automatically scaffolds CISO-grade Zero-Trust directives into `.cursorrules`, `.windsurfrules`, `CLAUDE.md`, `.github/copilot-instructions.md`, or `.clinerules`.
 
-### 4. `check_status`
+*   **Arguments:**
+    *   `agent_types` (array, optional): `["all"]`, `["cursor"]`, `["windsurf"]`, `["claude_code"]`, `["copilot"]`, `["cline"]`. Defaults to `["all"]`.
+    *   `workspace_dir` (string, optional): Workspace directory.
+
+### 9. `check_status`
 
 Returns a visual dashboard showing your current tier, session request count, active profiles, and upgrade instructions. Use it at any time to check your license status or get setup help.
 
@@ -188,13 +244,13 @@ Returns a visual dashboard showing your current tier, session request count, act
 *   **Response Example (Free Tier):**
     ```
     ╔══════════════════════════════════════════════════╗
-    ║       PrivacyScrubber MCP Server v1.6.6          ║
+    ║       PrivacyScrubber MCP Server v2.2.0          ║
     ╠══════════════════════════════════════════════════╣
     ║  🔓 Tier: FREE                                   ║
     ║  📊 Session requests: 5                          ║
-    ║  📁 Input size limit: 50,000 characters per request║
+    ║  📁 Input size limit: 15,000 characters/request  ║
     ╠══════════════════════════════════════════════════╣
-    ║  🏷️  Profiles: General only — PRO unlocks 22 more  ║
+    ║  🏷️  Profiles: General only — PRO unlocks 25 more ║
     ║  📋 Custom rules: 🔒 Locked — requires PRO       ║
     ╠══════════════════════════════════════════════════╣
     ║  💳 Upgrade to PRO — $110 Lifetime               ║
@@ -209,6 +265,52 @@ Returns a visual dashboard showing your current tier, session request count, act
 
 ---
 
+## 🛡️ Standalone CLI: `ps-guard`
+
+PrivacyScrubber bundles `ps-guard` for Unix pipe, pre-commit, and agentic workflows:
+
+```bash
+# Pipe any output through RAM redaction
+cat .env | npx ps-guard --profile dev
+
+# Execute commands through the ZTDS safety wrapper
+npx ps-guard -- npm test
+
+# Review git diff with secrets redacted
+npx ps-guard --diff --staged
+
+# Generate rules for all AI IDEs (.cursorrules, .windsurfrules, CLAUDE.md, copilot, cline)
+npx ps-guard --rules
+```
+
+---
+
+## 🌐 Browser Extension & Web Client
+
+Looking for real-time protection directly inside your web browser?
+*   **Chrome Extension:** Get the [PrivacyScrubber Chrome Extension](https://chromewebstore.google.com/detail/privacyscrubber-%E2%80%94-pii-red/pimoejgefeilajmmbpghifdmhdlkgjol) to sanitize prompts directly inside ChatGPT, Claude, and Gemini in real-time.
+*   **Web Sandbox:** Use the zero-server browser sanitization tools at [PrivacyScrubber Homepage](https://privacyscrubber.com/?utm_source=npm&utm_medium=readme&utm_campaign=mcp_server).
+
+## 📄 License & Commercial Upgrade
+
+By default, the server runs under the **Free Tier** (restricted to 15,000 characters per request and the basic `General` PII profile). To unlock 25 specialized engineering, medical, legal, and financial PII profiles, as well as team-wide custom rules, you can purchase a commercial license.
+
+### Feature Comparison
+
+| Feature | Free Tier | PRO Tier | TEAMS Tier |
+| :--- | :--- | :--- | :--- |
+| **Volatile Tokenization** | ✅ Yes | ✅ Yes | ✅ Yes |
+| **Standard PII Masking** | ✅ Yes | ✅ Yes | ✅ Yes |
+| **Max Character Length** | 15,000 chars | ♾️ Unlimited | ♾️ Unlimited |
+| **Industry Profiles** | General Only | 25 Profiles | 25 Profiles |
+| **Custom Regex Rules** | ❌ Locked | ♾️ Unlimited | ♾️ Unlimited |
+| **Team Rules Sync (GPO)** | ❌ No | ❌ No | ✅ Yes (Shared Link) |
+| **Licensing Cost** | $0 | **$110 Lifetime** | **$99/mo Flat Rate** |
+
+👉 **[Acquire a PRO / TEAMS License Key at privacyscrubber.com/pricing](https://privacyscrubber.com/pricing?utm_source=npm&utm_medium=readme&utm_campaign=mcp_server)**
+
+---
+
 ## 🔐 After Purchase: Activate PRO in Your MCP Client
 
 After purchasing a PRO license at [privacyscrubber.com/pricing](https://privacyscrubber.com/pricing?utm_source=npm&utm_medium=readme&utm_campaign=mcp_server), you will receive a license key. Add it to your MCP client config as an environment variable: `PRIVACYSCRUBBER_KEY`.