vacumify-mcp 0.0.0-stage → 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 +58 -2
- package/bin/vacumify-mcp.js +98 -0
- package/package.json +26 -6
package/README.md
CHANGED
|
@@ -1,3 +1,59 @@
|
|
|
1
|
-
#
|
|
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
|
+
|
|
5
|
+
Runs completely standalone over `stdio` without opening the desktop GUI. If `Vacumify.exe` is not found locally, `npx -y vacumify-mcp` automatically downloads the official Windows x64 binary from GitHub Releases into `~/.vacumify/`.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Quick Install
|
|
10
|
+
|
|
11
|
+
### Run directly with npx
|
|
12
|
+
```bash
|
|
13
|
+
npx -y vacumify-mcp
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Global npm install
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g vacumify-mcp
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Claude Code CLI
|
|
22
|
+
```bash
|
|
23
|
+
claude mcp add vacumify npx -y vacumify-mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Claude Desktop / Cursor (`config.json`)
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"mcpServers": {
|
|
30
|
+
"vacumify": {
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["-y", "vacumify-mcp"]
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Exposed MCP Tools
|
|
41
|
+
|
|
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
|
|
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.
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const { spawn, execSync } = require('child_process');
|
|
4
|
+
const fs = require('fs');
|
|
5
|
+
const path = require('path');
|
|
6
|
+
|
|
7
|
+
function findVacumifyExecutable() {
|
|
8
|
+
// 1. Explicit env variable
|
|
9
|
+
if (process.env.VACUMIFY_PATH && fs.existsSync(process.env.VACUMIFY_PATH)) {
|
|
10
|
+
return process.env.VACUMIFY_PATH;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
// 2. Relative paths within the Vacumify repo
|
|
14
|
+
const candidates = [
|
|
15
|
+
path.resolve(__dirname, '../../StorageCleaner/StorageCleaner/bin/Release/net10.0-windows/win-x64/publish/Vacumify.exe'),
|
|
16
|
+
path.resolve(__dirname, '../../StorageCleaner/StorageCleaner/bin/Release/net10.0-windows/win-x64/Vacumify.exe'),
|
|
17
|
+
path.resolve(__dirname, '../../StorageCleaner/StorageCleaner/bin/Debug/net10.0-windows/Vacumify.exe'),
|
|
18
|
+
path.resolve(process.cwd(), 'Vacumify.exe')
|
|
19
|
+
];
|
|
20
|
+
|
|
21
|
+
for (const cand of candidates) {
|
|
22
|
+
if (fs.existsSync(cand)) return cand;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// 3. Check ~/.vacumify auto-install directory
|
|
26
|
+
const userHome = process.env.USERPROFILE || process.env.HOME || '';
|
|
27
|
+
const autoInstallDir = path.join(userHome, '.vacumify');
|
|
28
|
+
const autoInstallExe = path.join(autoInstallDir, 'Vacumify.exe');
|
|
29
|
+
if (fs.existsSync(autoInstallExe)) return autoInstallExe;
|
|
30
|
+
|
|
31
|
+
// 4. Search PATH on Windows
|
|
32
|
+
if (process.platform === 'win32') {
|
|
33
|
+
try {
|
|
34
|
+
const stdout = execSync('where.exe Vacumify.exe', { stdio: ['pipe', 'pipe', 'ignore'], encoding: 'utf8' });
|
|
35
|
+
const firstLine = stdout.trim().split(/\r?\n/)[0];
|
|
36
|
+
if (firstLine && fs.existsSync(firstLine)) return firstLine;
|
|
37
|
+
} catch (_) {}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
function downloadAndExtractRelease() {
|
|
44
|
+
if (process.platform !== 'win32') {
|
|
45
|
+
console.error('[vacumify-mcp] Vacumify currently supports Windows (x64).');
|
|
46
|
+
process.exit(1);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
const userHome = process.env.USERPROFILE || process.env.HOME || '';
|
|
50
|
+
const autoInstallDir = path.join(userHome, '.vacumify');
|
|
51
|
+
const autoInstallExe = path.join(autoInstallDir, 'Vacumify.exe');
|
|
52
|
+
const url = 'https://github.com/kuroi17/Vacumify/releases/latest/download/Vacumify-win-x64.zip';
|
|
53
|
+
|
|
54
|
+
console.error('[vacumify-mcp] Vacumify.exe not found locally. Downloading latest release from GitHub...');
|
|
55
|
+
|
|
56
|
+
try {
|
|
57
|
+
if (!fs.existsSync(autoInstallDir)) fs.mkdirSync(autoInstallDir, { recursive: true });
|
|
58
|
+
const zipPath = path.join(autoInstallDir, 'Vacumify-win-x64.zip');
|
|
59
|
+
|
|
60
|
+
execSync(`powershell -Command "Invoke-WebRequest -Uri '${url}' -OutFile '${zipPath}'; Expand-Archive -Path '${zipPath}' -DestinationPath '${autoInstallDir}' -Force; Remove-Item '${zipPath}'"`, {
|
|
61
|
+
stdio: ['ignore', 'inherit', 'inherit']
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
if (fs.existsSync(autoInstallExe)) {
|
|
65
|
+
console.error('[vacumify-mcp] Successfully installed Vacumify to ' + autoInstallDir);
|
|
66
|
+
return autoInstallExe;
|
|
67
|
+
}
|
|
68
|
+
} catch (err) {
|
|
69
|
+
console.error('[vacumify-mcp] Auto-download failed: ' + err.message);
|
|
70
|
+
}
|
|
71
|
+
return null;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
let exePath = findVacumifyExecutable() || downloadAndExtractRelease();
|
|
75
|
+
|
|
76
|
+
if (!exePath) {
|
|
77
|
+
console.error('[vacumify-mcp] Error: Vacumify.exe not found.');
|
|
78
|
+
console.error('[vacumify-mcp] Please either:');
|
|
79
|
+
console.error(' 1. Set VACUMIFY_PATH environment variable to the path of Vacumify.exe');
|
|
80
|
+
console.error(' 2. Place Vacumify.exe in your PATH');
|
|
81
|
+
console.error(' 3. Or build the project: dotnet publish StorageCleaner/StorageCleaner/StorageCleaner.csproj -c Release -r win-x64 --self-contained true');
|
|
82
|
+
process.exit(1);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
const child = spawn(exePath, ['--mcp'], {
|
|
86
|
+
stdio: 'inherit',
|
|
87
|
+
windowsHide: true
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
child.on('error', (err) => {
|
|
91
|
+
console.error(`[vacumify-mcp] Failed to spawn Vacumify: ${err.message}`);
|
|
92
|
+
process.exit(1);
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
child.on('exit', (code, signal) => {
|
|
96
|
+
process.exit(code ?? (signal ? 1 : 0));
|
|
97
|
+
});
|
|
98
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "vacumify-mcp",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "vacumify-mcp",
|
|
3
|
+
"version": "1.1.0",
|
|
4
|
+
"description": "Model Context Protocol (MCP) server for Vacumify — Fast, local-first storage cleaner and duplicate finder for AI agents (Claude Code, Cursor, Antigravity, VS Code)",
|
|
5
|
+
"main": "bin/vacumify-mcp.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"vacumify-mcp": "bin/vacumify-mcp.js"
|
|
8
|
+
},
|
|
9
|
+
"keywords": [
|
|
10
|
+
"mcp",
|
|
11
|
+
"model-context-protocol",
|
|
12
|
+
"vacumify",
|
|
13
|
+
"disk-cleaner",
|
|
14
|
+
"duplicate-finder",
|
|
15
|
+
"storage",
|
|
16
|
+
"claude",
|
|
17
|
+
"cursor",
|
|
18
|
+
"ai-agent"
|
|
19
|
+
],
|
|
20
|
+
"author": "kuroi17",
|
|
21
|
+
"license": "MIT",
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "git+https://github.com/kuroi17/Vacumify.git"
|
|
25
|
+
}
|
|
26
|
+
}
|