vacumify-mcp 1.0.0 → 1.2.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 +37 -26
- package/bin/vacumify-mcp.js +604 -68
- package/lib/scanner.js +603 -0
- package/package.json +34 -26
package/README.md
CHANGED
|
@@ -1,48 +1,59 @@
|
|
|
1
|
-
# Vacumify Model Context Protocol (MCP) Server
|
|
1
|
+
# Vacumify Model Context Protocol (MCP) Server (`vacumify-mcp`)
|
|
2
2
|
|
|
3
3
|
Connect **Vacumify** directly to AI agent environments such as **Claude Code**, **Claude Desktop**, **Cursor**, **Windsurf**, and **Google Antigravity**.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Runs completely standalone in pure Node.js (zero dependencies, zero `.exe` downloads) over `stdio` on **Windows, macOS, and Linux** — no desktop GUI installation required.
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Quick Install
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
### Run directly with npx
|
|
12
|
+
```bash
|
|
13
|
+
npx -y vacumify-mcp
|
|
14
|
+
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
### Global npm install
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g vacumify-mcp
|
|
19
|
+
```
|
|
17
20
|
|
|
18
|
-
|
|
21
|
+
### Claude Code CLI
|
|
22
|
+
```bash
|
|
23
|
+
claude mcp add vacumify npx -y vacumify-mcp
|
|
24
|
+
```
|
|
19
25
|
|
|
20
|
-
###
|
|
26
|
+
### Claude Desktop / Cursor (`config.json`)
|
|
21
27
|
```json
|
|
22
28
|
{
|
|
23
29
|
"mcpServers": {
|
|
24
30
|
"vacumify": {
|
|
25
|
-
"command": "
|
|
26
|
-
"args": ["
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["-y", "vacumify-mcp"]
|
|
27
33
|
}
|
|
28
34
|
}
|
|
29
35
|
}
|
|
30
36
|
```
|
|
31
37
|
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
claude mcp add vacumify -- C:\path\to\Vacumify.exe --mcp
|
|
35
|
-
```
|
|
38
|
+
---
|
|
36
39
|
|
|
37
|
-
|
|
38
|
-
- **Name**: `vacumify`
|
|
39
|
-
- **Type**: `command`
|
|
40
|
-
- **Command**: `C:\path\to\Vacumify.exe --mcp`
|
|
40
|
+
## Exposed MCP Tools
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
42
|
+
1. **`vacumify_scan`**: Parallel multi-core scan with full GUI condition parity:
|
|
43
|
+
* `forgottenDays` (default `30`): Days untouched threshold.
|
|
44
|
+
* `minLargeFileBytes` (default `104857600` / 100 MB): Large file size threshold.
|
|
45
|
+
* `minDuplicateBytes` (default `102400` / 100 KB): Minimum duplicate hashing threshold.
|
|
46
|
+
* Includes **Active vs Dormant vs Abandoned** project scoring so AI agents never suggest deleting active work.
|
|
47
|
+
2. **`vacumify_get_dev_caches`**: Detects `node_modules`, Python `venv`/`.venv`, Rust `target`, .NET `bin`/`obj`, and Gradle caches with `olderThanDays` age filter and **Active vs Abandoned** protection.
|
|
48
|
+
3. **`vacumify_get_safe_junk`**: Identifies 100% zero-risk safe junk: redundant duplicate copies (preserving copy #1 intact), obsolete downloads installers untouched for 30+ days, and dead crash dumps.
|
|
49
|
+
4. **`vacumify_recycle_items`**: Safely moves specified files or folders to the **Windows Recycle Bin** (supports `dryRun: true`; never permanently deletes).
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Exposed MCP Slash Prompts
|
|
48
54
|
|
|
55
|
+
* `/audit-storage` — Complete overview audit (duplicates, large files, forgotten files, dev caches).
|
|
56
|
+
* `/duplicates` — Identify duplicate files with Keep Newest / Keep Oldest recommendation.
|
|
57
|
+
* `/forgotten-files` — Surface untouched files matching `forgottenDays`.
|
|
58
|
+
* `/large-files` — Rank heavy storage hogs matching `minLargeFileMB`.
|
|
59
|
+
* `/dev-caches` — Isolate bloated build caches while protecting active projects.
|