@danielsimonjr/memory-mcp 0.7.0

package/README.md

@@ -0,0 +1,283 @@
+# Knowledge Graph Memory Server
+
+A basic implementation of persistent memory using a local knowledge graph. This lets Claude remember information about the user across chats.
+
+## Core Concepts
+
+### Entities
+Entities are the primary nodes in the knowledge graph. Each entity has:
+- A unique name (identifier)
+- An entity type (e.g., "person", "organization", "event")
+- A list of observations
+
+Example:
+```json
+{
+  "name": "John_Smith",
+  "entityType": "person",
+  "observations": ["Speaks fluent Spanish"]
+}
+```
+
+### Relations
+Relations define directed connections between entities. They are always stored in active voice and describe how entities interact or relate to each other.
+
+Example:
+```json
+{
+  "from": "John_Smith",
+  "to": "Anthropic",
+  "relationType": "works_at"
+}
+```
+### Observations
+Observations are discrete pieces of information about an entity. They are:
+
+- Stored as strings
+- Attached to specific entities
+- Can be added or removed independently
+- Should be atomic (one fact per observation)
+
+Example:
+```json
+{
+  "entityName": "John_Smith",
+  "observations": [
+    "Speaks fluent Spanish",
+    "Graduated in 2019",
+    "Prefers morning meetings"
+  ]
+}
+```
+
+## API
+
+### Tools
+- **create_entities**
+  - Create multiple new entities in the knowledge graph
+  - Input: `entities` (array of objects)
+    - Each object contains:
+      - `name` (string): Entity identifier
+      - `entityType` (string): Type classification
+      - `observations` (string[]): Associated observations
+  - Ignores entities with existing names
+
+- **create_relations**
+  - Create multiple new relations between entities
+  - Input: `relations` (array of objects)
+    - Each object contains:
+      - `from` (string): Source entity name
+      - `to` (string): Target entity name
+      - `relationType` (string): Relationship type in active voice
+  - Skips duplicate relations
+
+- **add_observations**
+  - Add new observations to existing entities
+  - Input: `observations` (array of objects)
+    - Each object contains:
+      - `entityName` (string): Target entity
+      - `contents` (string[]): New observations to add
+  - Returns added observations per entity
+  - Fails if entity doesn't exist
+
+- **delete_entities**
+  - Remove entities and their relations
+  - Input: `entityNames` (string[])
+  - Cascading deletion of associated relations
+  - Silent operation if entity doesn't exist
+
+- **delete_observations**
+  - Remove specific observations from entities
+  - Input: `deletions` (array of objects)
+    - Each object contains:
+      - `entityName` (string): Target entity
+      - `observations` (string[]): Observations to remove
+  - Silent operation if observation doesn't exist
+
+- **delete_relations**
+  - Remove specific relations from the graph
+  - Input: `relations` (array of objects)
+    - Each object contains:
+      - `from` (string): Source entity name
+      - `to` (string): Target entity name
+      - `relationType` (string): Relationship type
+  - Silent operation if relation doesn't exist
+
+- **read_graph**
+  - Read the entire knowledge graph
+  - No input required
+  - Returns complete graph structure with all entities and relations
+
+- **search_nodes**
+  - Search for nodes based on query
+  - Input: `query` (string)
+  - Searches across:
+    - Entity names
+    - Entity types
+    - Observation content
+  - Returns matching entities and their relations
+
+- **open_nodes**
+  - Retrieve specific nodes by name
+  - Input: `names` (string[])
+  - Returns:
+    - Requested entities
+    - Relations between requested entities
+  - Silently skips non-existent nodes
+
+# Usage with Claude Desktop
+
+### Setup
+
+Add this to your claude_desktop_config.json:
+
+#### Docker
+
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "docker",
+      "args": ["run", "-i", "-v", "claude-memory:/app/dist", "--rm", "mcp/memory"]
+    }
+  }
+}
+```
+
+#### NPX
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@modelcontextprotocol/server-memory"
+      ]
+    }
+  }
+}
+```
+
+#### NPX with custom setting
+
+The server can be configured using the following environment variables:
+
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@modelcontextprotocol/server-memory"
+      ],
+      "env": {
+        "MEMORY_FILE_PATH": "/path/to/custom/memory.jsonl"
+      }
+    }
+  }
+}
+```
+
+- `MEMORY_FILE_PATH`: Path to the memory storage JSONL file (default: `memory.jsonl` in the server directory)
+
+# VS Code Installation Instructions
+
+For quick installation, use one of the one-click installation buttons below:
+
+[![Install with NPX in VS Code](https://img.shields.io/badge/VS_Code-NPM-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=memory&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40modelcontextprotocol%2Fserver-memory%22%5D%7D) [![Install with NPX in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-NPM-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=memory&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40modelcontextprotocol%2Fserver-memory%22%5D%7D&quality=insiders)
+
+[![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22-v%22%2C%22claude-memory%3A%2Fapp%2Fdist%22%2C%22--rm%22%2C%22mcp%2Fmemory%22%5D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22-v%22%2C%22claude-memory%3A%2Fapp%2Fdist%22%2C%22--rm%22%2C%22mcp%2Fmemory%22%5D%7D&quality=insiders)
+
+For manual installation, you can configure the MCP server using one of these methods:
+
+**Method 1: User Configuration (Recommended)**
+Add the configuration to your user-level MCP configuration file. Open the Command Palette (`Ctrl + Shift + P`) and run `MCP: Open User Configuration`. This will open your user `mcp.json` file where you can add the server configuration.
+
+**Method 2: Workspace Configuration**
+Alternatively, you can add the configuration to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.
+
+> For more details about MCP configuration in VS Code, see the [official VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/mcp).
+
+#### NPX
+
+```json
+{
+  "servers": {
+    "memory": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@modelcontextprotocol/server-memory"
+      ]
+    }
+  }
+}
+```
+
+#### Docker
+
+```json
+{
+  "servers": {
+    "memory": {
+      "command": "docker",
+      "args": [
+        "run",
+        "-i",
+        "-v",
+        "claude-memory:/app/dist",
+        "--rm",
+        "mcp/memory"
+      ]
+    }
+  }
+}
+```
+
+### System Prompt
+
+The prompt for utilizing memory depends on the use case. Changing the prompt will help the model determine the frequency and types of memories created.
+
+Here is an example prompt for chat personalization. You could use this prompt in the "Custom Instructions" field of a [Claude.ai Project](https://www.anthropic.com/news/projects). 
+
+```
+Follow these steps for each interaction:
+
+1. User Identification:
+   - You should assume that you are interacting with default_user
+   - If you have not identified default_user, proactively try to do so.
+
+2. Memory Retrieval:
+   - Always begin your chat by saying only "Remembering..." and retrieve all relevant information from your knowledge graph
+   - Always refer to your knowledge graph as your "memory"
+
+3. Memory
+   - While conversing with the user, be attentive to any new information that falls into these categories:
+     a) Basic Identity (age, gender, location, job title, education level, etc.)
+     b) Behaviors (interests, habits, etc.)
+     c) Preferences (communication style, preferred language, etc.)
+     d) Goals (goals, targets, aspirations, etc.)
+     e) Relationships (personal and professional relationships up to 3 degrees of separation)
+
+4. Memory Update:
+   - If any new information was gathered during the interaction, update your memory as follows:
+     a) Create entities for recurring organizations, people, and significant events
+     b) Connect them to the current entities using relations
+     c) Store facts about them as observations
+```
+
+## Building
+
+Docker:
+
+```sh
+docker build -t mcp/memory -f src/memory/Dockerfile . 
+```
+
+For Awareness: a prior mcp/memory volume contains an index.js file that could be overwritten by the new container. If you are using a docker volume for storage, delete the old docker volume's `index.js` file before starting the new container.
+
+## License
+
+This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

package/dist/__tests__/file-path.test.js

@@ -0,0 +1,119 @@
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
+import { promises as fs } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { ensureMemoryFilePath, defaultMemoryPath } from '../index.js';
+describe('ensureMemoryFilePath', () => {
+    const testDir = path.dirname(fileURLToPath(import.meta.url));
+    const oldMemoryPath = path.join(testDir, '..', 'memory.json');
+    const newMemoryPath = path.join(testDir, '..', 'memory.jsonl');
+    let originalEnv;
+    beforeEach(() => {
+        // Save original environment variable
+        originalEnv = process.env.MEMORY_FILE_PATH;
+        // Delete environment variable
+        delete process.env.MEMORY_FILE_PATH;
+    });
+    afterEach(async () => {
+        // Restore original environment variable
+        if (originalEnv !== undefined) {
+            process.env.MEMORY_FILE_PATH = originalEnv;
+        }
+        else {
+            delete process.env.MEMORY_FILE_PATH;
+        }
+        // Clean up test files
+        try {
+            await fs.unlink(oldMemoryPath);
+        }
+        catch {
+            // Ignore if file doesn't exist
+        }
+        try {
+            await fs.unlink(newMemoryPath);
+        }
+        catch {
+            // Ignore if file doesn't exist
+        }
+    });
+    describe('with MEMORY_FILE_PATH environment variable', () => {
+        it('should return absolute path when MEMORY_FILE_PATH is absolute', async () => {
+            const absolutePath = '/tmp/custom-memory.jsonl';
+            process.env.MEMORY_FILE_PATH = absolutePath;
+            const result = await ensureMemoryFilePath();
+            expect(result).toBe(absolutePath);
+        });
+        it('should convert relative path to absolute when MEMORY_FILE_PATH is relative', async () => {
+            const relativePath = 'custom-memory.jsonl';
+            process.env.MEMORY_FILE_PATH = relativePath;
+            const result = await ensureMemoryFilePath();
+            expect(path.isAbsolute(result)).toBe(true);
+            expect(result).toContain('custom-memory.jsonl');
+        });
+        it('should handle Windows absolute paths', async () => {
+            const windowsPath = 'C:\\temp\\memory.jsonl';
+            process.env.MEMORY_FILE_PATH = windowsPath;
+            const result = await ensureMemoryFilePath();
+            // On Windows, should return as-is; on Unix, will be treated as relative
+            if (process.platform === 'win32') {
+                expect(result).toBe(windowsPath);
+            }
+            else {
+                expect(path.isAbsolute(result)).toBe(true);
+            }
+        });
+    });
+    describe('without MEMORY_FILE_PATH environment variable', () => {
+        it('should return default path when no files exist', async () => {
+            const result = await ensureMemoryFilePath();
+            expect(result).toBe(defaultMemoryPath);
+        });
+        it('should migrate from memory.json to memory.jsonl when only old file exists', async () => {
+            // Create old memory.json file
+            await fs.writeFile(oldMemoryPath, '{"test":"data"}');
+            const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => { });
+            const result = await ensureMemoryFilePath();
+            expect(result).toBe(defaultMemoryPath);
+            // Verify migration happened
+            const newFileExists = await fs.access(newMemoryPath).then(() => true).catch(() => false);
+            const oldFileExists = await fs.access(oldMemoryPath).then(() => true).catch(() => false);
+            expect(newFileExists).toBe(true);
+            expect(oldFileExists).toBe(false);
+            // Verify console messages
+            expect(consoleErrorSpy).toHaveBeenCalledWith(expect.stringContaining('DETECTED: Found legacy memory.json file'));
+            expect(consoleErrorSpy).toHaveBeenCalledWith(expect.stringContaining('COMPLETED: Successfully migrated'));
+            consoleErrorSpy.mockRestore();
+        });
+        it('should use new file when both old and new files exist', async () => {
+            // Create both files
+            await fs.writeFile(oldMemoryPath, '{"old":"data"}');
+            await fs.writeFile(newMemoryPath, '{"new":"data"}');
+            const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => { });
+            const result = await ensureMemoryFilePath();
+            expect(result).toBe(defaultMemoryPath);
+            // Verify no migration happened (both files should still exist)
+            const newFileExists = await fs.access(newMemoryPath).then(() => true).catch(() => false);
+            const oldFileExists = await fs.access(oldMemoryPath).then(() => true).catch(() => false);
+            expect(newFileExists).toBe(true);
+            expect(oldFileExists).toBe(true);
+            // Verify no console messages about migration
+            expect(consoleErrorSpy).not.toHaveBeenCalled();
+            consoleErrorSpy.mockRestore();
+        });
+        it('should preserve file content during migration', async () => {
+            const testContent = '{"entities": [{"name": "test", "type": "person"}]}';
+            await fs.writeFile(oldMemoryPath, testContent);
+            await ensureMemoryFilePath();
+            const migratedContent = await fs.readFile(newMemoryPath, 'utf-8');
+            expect(migratedContent).toBe(testContent);
+        });
+    });
+    describe('defaultMemoryPath', () => {
+        it('should end with memory.jsonl', () => {
+            expect(defaultMemoryPath).toMatch(/memory\.jsonl$/);
+        });
+        it('should be an absolute path', () => {
+            expect(path.isAbsolute(defaultMemoryPath)).toBe(true);
+        });
+    });
+});