@streamblur/mcp 0.1.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,43 +1,95 @@
1
- # streamblur-mcp
1
+ # @streamblur/mcp
2
2
 
3
- StreamBlur MCP server that redacts API keys, tokens, credentials, and sensitive secrets from text and files.
3
+ **StreamBlur MCP Server** Automatically redact API keys, tokens, passwords, and credentials from any text or file your AI assistant touches.
4
4
 
5
- ## Features
5
+ [![npm version](https://img.shields.io/npm/v/@streamblur/mcp.svg)](https://www.npmjs.com/package/@streamblur/mcp)
6
+ [![npm downloads](https://img.shields.io/npm/dw/@streamblur/mcp.svg)](https://www.npmjs.com/package/@streamblur/mcp)
6
7
 
7
- - 3 MCP tools:
8
- - `redact_text`: Redact secrets in a string.
9
- - `redact_file`: Read a file and return redacted content without writing changes.
10
- - `scan_text`: Return detected secrets with `type`, `start`, and `end` positions.
11
- - 50+ credential patterns including OpenAI, Anthropic, GitHub, AWS, Stripe, Twilio, Slack, SendGrid, database URLs, bearer tokens, private keys, and generic `.env` assignments.
8
+ ## What it does
9
+
10
+ When your AI coding assistant reads config files, environment variables, or any text containing secrets — StreamBlur automatically redacts them before they appear in your AI context window. 50+ credential patterns detected including OpenAI, Anthropic, AWS, Stripe, GitHub, and more.
12
11
 
13
12
  ## Install
14
13
 
15
14
  ```bash
16
- npm install
17
- npm run build
15
+ npm install -g @streamblur/mcp
18
16
  ```
19
17
 
20
- ## Run
18
+ ## Usage with Claude Desktop
21
19
 
22
- ```bash
23
- streamblur-mcp
20
+ Add to your `claude_desktop_config.json`:
21
+
22
+ ```json
23
+ {
24
+ "mcpServers": {
25
+ "streamblur": {
26
+ "command": "npx",
27
+ "args": ["-y", "@streamblur/mcp"],
28
+ "env": {
29
+ "STREAMBLUR_LICENSE_KEY": "your-pro-email-or-license-key"
30
+ }
31
+ }
32
+ }
33
+ }
24
34
  ```
25
35
 
26
- or
36
+ ## Usage with Cursor / Windsurf / other MCP clients
27
37
 
28
- ```bash
29
- node dist/index.js
38
+ ```json
39
+ {
40
+ "streamblur": {
41
+ "command": "npx",
42
+ "args": ["-y", "@streamblur/mcp"],
43
+ "env": {
44
+ "STREAMBLUR_LICENSE_KEY": "your-pro-email-or-license-key"
45
+ }
46
+ }
47
+ }
30
48
  ```
31
49
 
32
- ## Development
50
+ ## Tools
33
51
 
34
- ```bash
35
- npm run build
36
- node dist/test/redact.test.js
37
- ```
52
+ ### Free
38
53
 
39
- ## Quick manual redaction check
54
+ | Tool | Description |
55
+ |------|-------------|
56
+ | `redact_text` | Redact secrets from any string. Returns text with `[REDACTED:type]` placeholders. |
57
+ | `scan_text` | Scan text and return detected secrets with type and character position. |
58
+
59
+ ### Pro — requires `STREAMBLUR_LICENSE_KEY`
60
+
61
+ | Tool | Description |
62
+ |------|-------------|
63
+ | `redact_file` | Read a file and return redacted content. Supports `.env`, configs, source code. File is never modified. |
64
+ | `scan_directory` | Recursively scan a directory for leaked secrets. Returns file paths, secret types, and line numbers. Skips `node_modules`, `.git`, `dist`, and build folders. |
65
+
66
+ ## Detected Credential Types
67
+
68
+ OpenAI API keys · Anthropic API keys · AWS access keys · GitHub tokens · Stripe keys · Twilio auth tokens · Slack tokens · SendGrid keys · Database URLs · Bearer tokens · Private keys · `.env` assignments · and 40+ more patterns.
69
+
70
+ ## Get Pro
71
+
72
+ StreamBlur Pro is **$2.99 one-time** — no subscription, no recurring charges.
73
+
74
+ [Get Pro at streamblur.com/pricing](https://streamblur.com/pricing)
75
+
76
+ Once you have Pro, set your email or license key as `STREAMBLUR_LICENSE_KEY` in your MCP config to unlock `redact_file` and `scan_directory`.
77
+
78
+ ## Example
40
79
 
41
- ```bash
42
- node -e "const r = require('./dist/redact'); const text = require('fs').readFileSync('./test/sample-secrets.txt','utf8'); console.log('BEFORE:\n' + text); console.log('\nAFTER:\n' + r.redactText(text));"
43
80
  ```
81
+ // AI asks to read .env file
82
+ // Without StreamBlur: OPENAI_API_KEY=sk-proj-abc123...
83
+ // With StreamBlur: OPENAI_API_KEY=[REDACTED:openai_project_key]
84
+ ```
85
+
86
+ ## Privacy
87
+
88
+ All pattern matching runs **100% locally**. Your files and text are never uploaded anywhere. The only network call is a one-time license key validation on startup (Pro only).
89
+
90
+ ## Links
91
+
92
+ - [streamblur.com](https://streamblur.com)
93
+ - [Chrome Extension](https://chromewebstore.google.com/detail/streamblur/ikbeaahlgjhcpmnmoephpcoabconahim)
94
+ - [Pricing](https://streamblur.com/pricing)
95
+ - [Discord](https://discord.gg/628jYn5TwC)