Memory Bank

by alioshr

178 stars
1.1k downloads
Not rated
GitHub Website

About

Transforms file-based memory banks into a centralized, remotely accessible service for multi-project management with consistent structure and validation.

Details

Author
alioshr
Repository
alioshr/memory-bank-mcp
GitHub stars
178
Downloads
1,144
License
MIT License
Categories
Developer Tools, Design, Workplace, File Management, AI, Infrastructure, Frontend, Communication, Knowledge Base
Tags
#mobile

- Multi-Project Support

- Project-specific directories
- File structure enforcement
- Path traversal prevention
- Project listing capabilities
- File listing per project

- Remote Accessibility

- Full MCP protocol implementation
- Type-safe operations
- Proper error handling
- Security through project isolation

- Core Operations
- Read/write/update memory bank files
- List available projects
- List files within projects
- Project existence validation
- Safe read-only operations

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Memory Bank
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 -y
    • Argument 2 @allpepper/memory-bank-mcp
    Environment
    • MEMORY_BANK_ROOT <path-to-bank>

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

1. Configure the MCP server in your settings (see Configuration section below)
2. Start using the memory bank tools in your AI assistant

- MEMORY_BANK_ROOT: Directory where project memory banks will be stored (e.g., /path/to/memory-bank)
- disabled: Set to false to enable the server
- autoApprove: List of operations that don't require explicit user approval:
- memory_bank_read: Read memory bank files
- memory_bank_write: Create new memory bank files
- memory_bank_update: Update existing memory bank files
- list_projects: List available projects
- list_project_files: List files within a project

npm install

npm run dev


1. Build the Docker image:

bash
docker build -t memory-bank-mcp:local .

2. Run the Docker container for testing:

bash
docker run -i --rm \
-e MEMORY_BANK_ROOT="/mnt/memory_bank" \
-v /path/to/memory-bank:/mnt/memory_bank \
--entrypoint /bin/sh \
memory-bank-mcp:local \
-c "ls -la /mnt/memory_bank"

3. Add MCP configuration, example for Roo Code:

json
"allpepper-memory-bank": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e",
"MEMORY_BANK_ROOT",
"-v",
"/path/to/memory-bank:/mnt/memory_bank",
"memory-bank-mcp:local"
],
"env": {
"MEMORY_BANK_ROOT": "/mnt/memory_bank"
},
"disabled": false,
"alwaysAllow": [
"list_projects",
"list_project_files",
"memory_bank_read",
"memory_bank_update",
"memory_bank_write"
]
}
```

memory_bank_read

Read memory bank files.

memory_bank_write

Create new memory bank files.

memory_bank_update

Update existing memory bank files.

list_projects

List available projects.

list_project_files

List files within a project.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "memory bank": {
            "env": {
                "MEMORY_BANK_ROOT": "<path-to-bank>"
            },
            "args": [
                "-y",
                "@allpepper/memory-bank-mcp"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": {
        "MEMORY_BANK_ROOT": "<path-to-bank>"
    },
    "args": [
        "-y",
        "@allpepper/memory-bank-mcp"
    ],
    "command": "npx"
}

Macos

{
    "env": {
        "MEMORY_BANK_ROOT": "<path-to-bank>"
    },
    "args": [
        "-y",
        "@allpepper/memory-bank-mcp"
    ],
    "command": "npx"
}

Windows

{
    "env": {
        "MEMORY_BANK_ROOT": "<path-to-bank>"
    },
    "args": [
        "/c",
        "npx",
        "-y",
        "@allpepper/memory-bank-mcp"
    ],
    "command": "cmd"
}
# Memory Bank MCP Server [![smithery badge](https://smithery.ai/badge/@alioshr/memory-bank-mcp)](https://smithery.ai/server/@alioshr/memory-bank-mcp) [![npm version](https://badge.fury.io/js/%40allpepper%2Fmemory-bank-mcp.svg)](https://www.npmjs.com/package/@allpepper/memory-bank-mcp) [![npm downloads](https://img.shields.io/npm/dm/@allpepper/memory-bank-mcp.svg)](https://www.npmjs.com/package/@allpepper/memory-bank-mcp) <a href="https://glama.ai/mcp/servers/ir18x1tixp"><img width="380" height="200" src="https://glama.ai/mcp/servers/ir18x1tixp/badge" alt="Memory Bank Server MCP server" /></a> A Model Context Protocol (MCP) server implementation for remote memory bank management, inspired by [Cline Memory Bank](https://github.com/nickbaumann98/cline_docs/blob/main/prompting/custom%20instructions%20library/cline-memory-bank.md). ## Overview The Memory Bank MCP Server transforms traditional file-based memory banks into a centralized service that: - Provides remote access to memory bank files via MCP protocol - Enables multi-project memory bank management - Maintains consistent file structure and validation - Ensures proper isolation between project memory banks ## Features - **Multi-Project Support** - Project-specific directories - File structure enforcement - Path traversal prevention - Project listing capabilities - File listing per project - **Remote Accessibility** - Full MCP protocol implementation - Type-safe operations - Proper error handling - Security through project isolation - **Core Operations** - Read/write/update memory bank files - List available projects - List files within projects - Project existence validation - Safe read-only operations ## Installation To install Memory Bank Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@alioshr/memory-bank-mcp): ```bash npx -y @smithery/cli install @alioshr/memory-bank-mcp --client claude ``` This will set up the MCP server configuration automatically. Alternatively, you can configure the server manually as described in the Configuration section below. ## Quick Start 1. Configure the MCP server in your settings (see Configuration section below) 2. Start using the memory bank tools in your AI assistant ## Using with Cline/Roo Code The memory bank MCP server needs to be configured in your Cline MCP settings file. The location depends on your setup: - For Cline extension: `~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json` - For Roo Code VS Code extension: `~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json` Add the following configuration to your MCP settings: ```json { "allpepper-memory-bank": { "command": "npx", "args": ["-y", "@allpepper/memory-bank-mcp"], "env": { "MEMORY_BANK_ROOT": "<path-to-bank>" }, "disabled": false, "autoApprove": [ "memory_bank_read", "memory_bank_write", "memory_bank_update", "list_projects", "list_project_files" ] } } ``` ### Configuration Details - `MEMORY_BANK_ROOT`: Directory where project memory banks will be stored (e.g., `/path/to/memory-bank`) - `disabled`: Set to `false` to enable the server - `autoApprove`: List of operations that don't require explicit user approval: - `memory_bank_read`: Read memory bank files - `memory_bank_write`: Create new memory bank files - `memory_bank_update`: Update existing memory bank files - `list_projects`: List available projects - `list_project_files`: List files within a project ## Using with Cursor For Cursor, open the settings -> features -> add MCP server -> add the following: ```shell env MEMORY_BANK_ROOT=<path-to-bank> npx -y @allpepper/memory-bank-mcp@latest ``` ## Using with Claude - Claude desktop config file: `~/Library/Application Support/Claude/claude_desktop_config.json` - Claude Code config file: `~/.claude.json` 1. Locate the config file 3. Locate the property called `mcpServers` 4. Paste this: ``` "allPepper-memory-bank": { "type": "stdio", "command": "npx", "args": [ "-y", "@allpepper/memory-bank-mcp@latest" ], "env": { "MEMORY_BANK_ROOT": "YOUR PATH" } } ``` ## Custom AI instructions This section contains the instructions that should be pasted on the AI custom instructions, either for Cline, Claude or Cursor, or any other MCP client. You should copy and paste these rules. For reference, see [custom-instructions.md](custom-instructions.md) which contains these rules. ## Development Basic development commands: ```bash # Install dependencies npm install # Build the project npm run build # Run tests npm run test # Run tests in watch mode npm run test:watch # Run the server directly with ts-node for quick testing npm run dev ``` ### Running with Docker 1. Build the Docker image: ```bash docker build -t memory-bank-mcp:local . ``` 2. Run the Docker container for testing: ```bash docker run -i --rm \ -e MEMORY_BANK_ROOT="/mnt/memory_bank" \ -v /path/to/memory-bank:/mnt/memory_bank \ --entrypoint /bin/sh \ memory-bank-mcp:local \ -c "ls -la /mnt/memory_bank" ``` 3. Add MCP configuration, example for Roo Code: ```json "allpepper-memory-bank": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "MEMORY_BANK_ROOT", "-v", "/path/to/memory-bank:/mnt/memory_bank", "memory-bank-mcp:local" ], "env": { "MEMORY_BANK_ROOT": "/mnt/memory_bank" }, "disabled": false, "alwaysAllow": [ "list_projects", "list_project_files", "memory_bank_read", "memory_bank_update", "memory_bank_write" ] } ``` ## Contributing Contributions are welcome! Please follow these steps: 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request ### Development Guidelines - Use TypeScript for all new code - Maintain type safety across the codebase - Add tests for new features - Update documentation as needed - Follow existing code style and patterns ### Testing - Write unit tests for new features - Include multi-project scenario tests - Test error cases thoroughly - Validate type constraints - Mock filesystem operations appropriately ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ## Acknowledgments This project implements the memory bank concept originally documented in the [Cline Memory Bank](https://github.com/nickbaumann98/cline_docs/blob/main/prompting/custom%20instructions%20library/cline-memory-bank.md), extending it with remote capabilities and multi-project support.
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.