Memory Bank MCP

🚀 Memory Bank

Memory Bank is a command-line-based tool designed to manage and track the context information of software projects. It maintains multiple Markdown files to record the project's status, progress, and decision history. Users can invoke its functions via the command line or integrate it into their codebases.

🚀 Quick Start

Initialize the Memory Bank

Run the following command in your project's root directory to initialize a new Memory Bank:

memory-bank-mcp initialize_memory_bank path=./memory-bank

This will create all the necessary files and folders in the ./memory-bank directory.

Track Progress

When you complete a feature or fix an issue, you can use the following command to track the progress:

memory-bank-mcp track_progress action="New feature implementation" description="Implemented feature X"

Log Decisions

When making important decisions, it's recommended to log them for future reference:

memory-bank-mcp log_decision title="API design decision" context="..." decision="..."

Switch Modes

Switch between different working modes according to your needs:

memory-bank-mcp switch_mode mode=code

✨ Features

Memory Bank File Structure

Memory Bank uses the following Markdown files to organize information:

• product-context.md: Records the project overview, goals, and technology choices.
• active-context.md: Tracks the current status, known issues, and next steps.
• progress.md: Records project updates and milestones chronologically.
• decision-log.md: Records important decisions, their contexts, alternatives, and outcomes.
• system-patterns.md: Summarizes the design patterns in the system architecture and code.

Mode System

Memory Bank supports multiple operation modes:

• code: Focuses on code implementation.
• ask: Focuses on answering questions.
• architect: Focuses on system design.
• debug: Focuses on debugging issues.
• test: Focuses on testing.

Status Prefix System

Memory Bank implements status indicators to let users know its running status in real-time:

• [MEMORY BANK: ACTIVE]: The Memory Bank is ready and providing context support.
• [MEMORY BANK: INACTIVE]: The Memory Bank is not ready or misconfigured.
• [MEMORY BANK: UPDATING]: The Memory Bank is being updated (during the execution of UMB commands).

📦 Installation

You can install this tool using npm:

npm install -g @aakarsh-sasi/memory-bank-mcp

💻 Usage Examples

As a Command-Line Tool

# Initialize the Memory Bank
memory-bank-mcp initialize_memory_bank path=./memory-bank

# Track Progress
memory-bank-mcp track_progress action="Feature implementation" description="Implemented feature X"

# Log Decisions
memory-bank-mcp log_decision title="API design" context="..." decision="..."

# Switch Modes
memory-bank-mcp switch_mode mode=code

As a Library

import { MemoryBankServer } from "@aakarsh-sasi/memory-bank-mcp";

// Create a new server instance
const server = new MemoryBankServer();

// Start the server
server.run().catch(console.error);

📚 Documentation

Contribution Guidelines

Please refer to CONTRIBUTING.md to learn how to contribute code, including code standards and submission processes.

Changelog

The project follows semantic versioning and generates a changelog based on commit messages. When merging into the main branch, the version number is automatically incremented according to the commit messages:

• Major version is incremented when there are breaking changes (commit messages with BREAKING CHANGE or !: ).
• Minor version is incremented when new features are added (commit messages with feat: or feat(scope): ).
• Patch version is incremented for all other changes (bug fixes, documentation updates, etc.). The full change history can be found in the CHANGELOG.md file.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.