@aeriondyseti/vector-memory-mcp 0.3.0 → 0.4.0

package/README.md

@@ -57,21 +57,38 @@ A production-ready MCP (Model Context Protocol) server that provides semantic me
 
 > **Note:** This server requires Bun to run.
 
-### Installation
+### Installation & Configuration
 
+#### Option 1: Global Install (Recommended)
+
+**Install:**
 ```bash
-# Clone the repository
-git clone https://github.com/AerionDyseti/vector-memory-mcp.git
-cd vector-memory-mcp
+bun install -g @aeriondyseti/vector-memory-mcp
+```
 
-# Install dependencies
-bun install
+> **Note:** The installation automatically downloads ML models (~90MB) and verifies native dependencies. This may take a minute on first install.
+
+**Configure Claude Code** - Add to `~/.claude/config.json`:
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "vector-memory-mcp"
+    }
+  }
+}
 ```
 
-### Configure Claude Code
+#### Option 2: Local Development
 
-Add to your `~/.claude/config.json`:
+**Install:**
+```bash
+git clone https://github.com/AerionDyseti/vector-memory-mcp.git
+cd vector-memory-mcp
+bun install
+```
 
+**Configure Claude Code** - Add to `~/.claude/config.json`:
 ```json
 {
   "mcpServers": {
@@ -82,8 +99,17 @@ Add to your `~/.claude/config.json`:
   }
 }
 ```
+*Replace `/absolute/path/to/` with your actual installation path.*
+
+---
+
+**What gets installed:**
+- The vector-memory-mcp package and all dependencies
+- Native binaries for ONNX Runtime (~32MB) and image processing (~10MB)
+- ML model files automatically downloaded during installation (~90MB, cached in `~/.cache/huggingface/`)
+- **Total first-time setup:** ~130MB of downloads
 
-Replace `/absolute/path/to/` with your actual installation path.
+> 💡 **Tip:** If you need to re-download models or verify dependencies, run: `vector-memory-mcp warmup`
 
 ### Start Using It
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeriondyseti/vector-memory-mcp",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A zero-configuration RAG memory server for MCP clients",
   "type": "module",
   "main": "src/index.ts",
@@ -9,6 +9,7 @@
   },
   "files": [
     "src",
+    "scripts",
     "README.md",
     "LICENSE"
   ],
@@ -28,18 +29,24 @@
     "test": "bun test --preload ./tests/preload.ts",
     "test:quick": "bun test",
     "test:coverage": "bun test --preload ./tests/preload.ts --coverage",
-    "test:preload": "bun run tests/preload.ts"
+    "test:preload": "bun run tests/preload.ts",
+    "warmup": "bun run scripts/warmup.ts",
+    "postinstall": "bun run scripts/warmup.ts"
   },
-    "keywords": ["mcp", "memory", "rag", "embeddings", "lancedb"],
+  "keywords": ["mcp", "memory", "rag", "embeddings", "lancedb"],
   "license": "MIT",
   "dependencies": {
     "@lancedb/lancedb": "^0.22.3",
     "@modelcontextprotocol/sdk": "^1.0.0",
-    "@huggingface/transformers": "^3.8.0",
-    "apache-arrow": "^21.1.0"
+    "@huggingface/transformers": "^3.8.0"
   },
   "devDependencies": {
     "@types/bun": "latest",
     "typescript": "^5.0.0"
-  }
+  },
+  "trustedDependencies": [
+    "onnxruntime-node",
+    "protobufjs",
+    "sharp"
+  ]
 }

package/scripts/warmup.ts

@@ -0,0 +1,73 @@
+#!/usr/bin/env bun
+
+/**
+ * Warmup script to pre-download ML models and verify dependencies
+ * This runs during installation to ensure everything is ready to use
+ */
+
+import { config } from "../src/config/index.js";
+import { EmbeddingsService } from "../src/services/embeddings.service.js";
+
+async function warmup(): Promise<void> {
+  console.log("🔥 Warming up vector-memory-mcp...");
+  console.log();
+
+  try {
+    // Check native dependencies
+    console.log("✓ Checking native dependencies...");
+    try {
+      await import("onnxruntime-node");
+      console.log("  ✓ onnxruntime-node loaded");
+    } catch (e) {
+      console.error("  ✗ onnxruntime-node failed:", (e as Error).message);
+      process.exit(1);
+    }
+
+    try {
+      await import("sharp");
+      console.log("  ✓ sharp loaded");
+    } catch (e) {
+      console.error("  ✗ sharp failed:", (e as Error).message);
+      process.exit(1);
+    }
+
+    console.log();
+
+    // Initialize embeddings service to download model
+    console.log("📥 Downloading ML model (this may take a minute)...");
+    console.log(`   Model: ${config.embeddingModel}`);
+    console.log(`   Cache: ~/.cache/huggingface/`);
+    console.log();
+
+    const embeddings = new EmbeddingsService(
+      config.embeddingModel,
+      config.embeddingDimension
+    );
+
+    // Trigger model download by generating a test embedding
+    const startTime = Date.now();
+    await embeddings.embed("warmup test");
+    const duration = ((Date.now() - startTime) / 1000).toFixed(2);
+
+    console.log();
+    console.log(`✅ Warmup complete! (${duration}s)`);
+    console.log();
+    console.log("Ready to use! Configure Claude Code and restart to get started.");
+    console.log("See: https://github.com/AerionDyseti/vector-memory-mcp#configure-claude-code");
+    console.log();
+  } catch (error) {
+    console.error();
+    console.error("❌ Warmup failed:", error);
+    console.error();
+    console.error("This is not a critical error - the server will download models on first run.");
+    console.error("You can try running 'vector-memory-mcp warmup' manually later.");
+    process.exit(0); // Exit successfully to not block installation
+  }
+}
+
+// Only run if this is the main module
+if (import.meta.url === `file://${process.argv[1]}`) {
+  warmup();
+}
+
+export { warmup };

package/src/index.ts

@@ -8,6 +8,14 @@ import { MemoryService } from "./services/memory.service.js";
 import { startServer } from "./mcp/server.js";
 
 async function main(): Promise<void> {
+  // Check for warmup command
+  const args = process.argv.slice(2);
+  if (args[0] === "warmup") {
+    const { warmup } = await import("../scripts/warmup.js");
+    await warmup();
+    return;
+  }
+
   // Initialize database
   const db = await connectToDatabase(config.dbPath);