Memory Bank MCP

🚀 Memory Bank

The Memory Bank is a system for managing and maintaining project context, enabling AI assistants to easily access and update information.

🚀 Quick Start

The Memory Bank is a system designed to manage and maintain project context. It organizes information in a standardized structure, allowing AI assistants to easily access and update this information.

✨ Features

Core Functions

• Initialization: Create a new memory bank by calling the memory-bank-mcp initialize_memory_bank command.
• Progress Tracking: Use the track_progress tool to record project progress.
• Decision Logging: Record important decisions and their background information using the log_decision tool.
• Mode Switching: Switch between different operation modes as needed, such as code mode or problem-solving mode.

Data Flow

1. Initialization: The AI assistant connects to the Memory Bank server and initializes the memory bank.
2. Tool Invocation: The AI assistant reads and writes to the memory bank files through the tools provided by the Memory Bank server.
3. Context Maintenance: The Memory Bank maintains context information, enabling the AI to recall previous decisions and progress.

Structure

The Memory Bank uses a standardized structure to organize information:

• Product Background: Includes project overview, goals, technologies used, and architecture.
• Current Status: Records the current project status, ongoing tasks, known issues, and next steps.
• Progress History: Records project updates and milestones in chronological order.
• Decision Log: Records important decisions, their background, alternatives, and consequences.
• System Modes: Includes the project's architectural mode, code mode, and documentation mode.

Advanced Features

• UMB Commands: Temporarily update memory bank files during a session without committing changes.
• Mode Detection: Automatically detect and switch modes based on user input.
• File Migration Tool: Used to migrate between different file naming conventions.
• Language Standardization: All memory bank files are generated in English to ensure consistency.

📦 Installation

This project follows semantic versioning and Conventional Commits. The version number rules are as follows:

• Major Version: When there are breaking changes (e.g., BREAKING CHANGE or !: in the commit message).
• Minor Version: When new features are added (e.g., feat: or feat(scope): in the commit message).
• Patch Version: All other changes (e.g., bug fixes, documentation updates, etc.).

The full change history is recorded in the CHANGELOG.md file.

💻 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 a decision
memory-bank-mcp log_decision title="API design" context="..." decision="..."

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

As a Library

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

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

// Start the server
server.start();

📚 Documentation

Contribution Guidelines

• Code Style: Follow the project code style.
• Commit Guidelines: Refer to the commit guidelines.

License

This project is licensed under the MIT License, as follows:

MIT License
Copyright (c) 2024, Author Name
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Status System

Status Codes

• IDLE: Indicates that the server is idle.
• BUSY: Indicates that the server is processing a request.
• ERROR: Indicates that the server has encountered an error.

Status Query Command

# Query the current status
memory-bank-mcp get_status

Additional Resources

• Project Documentation
• Issue Submission

For more information about the Memory Bank, please visit the project homepage.