npm package: @surinder-with-ai/memory-bank-mcp
Description: Memory Bank MCP server for AI assistants that automatically creates and updates memory banks
Author: Surinder Singh
Latest version: 1.0.2

# Memory Bank MCP

Memory Bank MCP is a server that automatically creates and updates memory banks for AI assistants. It tracks code changes in your project and provides context to AI assistants through the Model Context Protocol (MCP).

## Features

- **Automatic Memory Bank Creation**: Creates a memory bank if one doesn't exist
- **Code Change Tracking**: Tracks added, modified, and removed files in your project
- **Context Updates on User Prompts**: Updates the memory bank when a user sends a prompt to the AI assistant
- **Manual Updates**: Provides tools for manual updates of the memory bank

## Installation

```bash
npm install -g memory-bank-mcp
```

## Usage

### CLI

```bash
# Start the MCP server (default)
memory-bank-mcp

# Initialize a new memory bank
memory-bank-mcp init

# List all files in the memory bank
memory-bank-mcp list

# Read all memory bank files and display their content
memory-bank-mcp read

# Start the MCP server with a specific project path
memory-bank-mcp serve --path /path/to/your/project
```

### API

```javascript
import {
  runMcpServer,
  createMemoryBank,
  readMemoryBank,
} from "memory-bank-mcp";

// Start the MCP server
await runMcpServer({ projectPath: "/path/to/your/project" });

// Create a memory bank
createMemoryBank("/path/to/your/project");

// Read memory bank content
const content = readMemoryBank("/path/to/your/project");
```

## Configuration

### Augment AI

Add the following to your `.augment-config.json` file:

```json
{
  "augment.advanced": {
    "mcpServers": [
      {
        "name": "memoryBank",
        "command": "memory-bank-mcp",
        "args": []
      }
    ]
  }
}
```

If you installed the package with npm instead of globally:

```json
{
  "augment.advanced": {
    "mcpServers": [
      {
        "name": "memoryBank",
        "command": "npx",
        "args": ["@surinder-with-ai/memory-bank-mcp"]
      }
    ]
  }
}
```

### VSCode AI

Add the following to your VSCode settings.json:

```json
{
  "ai.servers": {
    "MemoryBank": {
      "type": "stdio",
      "command": "memory-bank-mcp",
      "args": []
    }
  }
}
```

If you installed the package with npm instead of globally:

```json
{
  "ai.servers": {
    "MemoryBank": {
      "type": "stdio",
      "command": "npx",
      "args": ["@surinder-with-ai/memory-bank-mcp"]
    }
  }
}
```

### Cursor AI

Add the following to your `~/.cursor/mcp.json` file:

```json
{
  "mcpServers": {
    "memoryBank": {
      "command": "memory-bank-mcp",
      "args": []
    }
  }
}
```

If you installed the package with npm instead of globally:

```json
{
  "mcpServers": {
    "memoryBank": {
      "command": "npx",
      "args": ["@surinder-with-ai/memory-bank-mcp"]
    }
  }
}
```

### GitHub Copilot

Add the following to your settings.json:

```json
{
  "github.copilot.advanced": {
    "mcpServers": [
      {
        "name": "memoryBank",
        "command": "memory-bank-mcp",
        "args": []
      }
    ]
  }
}
```

## Memory Bank Structure

The memory bank consists of the following files:

- `activeContext.md`: Current work focus, recent changes, and next steps
- `productContext.md`: Why the project exists, problems it solves, and how it should work
- `progress.md`: What works, what's left to build, and current status
- `projectbrief.md`: Project overview, core requirements, and goals
- `systemPatterns.md`: System architecture, key technical decisions, and design patterns
- `techContext.md`: Technologies used, development setup, and dependencies
- `features/`: Directory for feature-specific files

## License

MIT