Memory Bank MCP

🚀 Memory Bank MCP Server

A Model Context Protocol (MCP) server implementation for remote memory bank management, inspired by Cline Memory Bank.

🚀 Quick Start

Memory Bank MCP Server transforms traditional file-based memory banks into a centralized service. It provides access to remote memory bank files via the MCP protocol, manages multi-project memory banks, maintains a consistent file structure and validation, and ensures isolation between projects.

✨ Features

Multi-Project Support

• Project-specific directories
• File path restrictions
• Content hash validation
• Multi-thread safety
• Error handling
• Documented API

MCP Protocol Integration

• Support for standard MCP operations
• Type-safe operations
• Responsive design
• Logging and tracking
• Flexibility and scalability

📦 Installation

Install via npm

npm install memory-bank-mcp-server

Quick Start Steps

1. Initialize the memory bank:

const MemoryBank = require('memory-bank-mcp-server');
const bank = new MemoryBank({
  root: '/path/to/bank',
  logger: {
    level: 'debug'
  }
});

2. Start the server:

bank.start();

📚 Documentation

Basic Configuration

const config = {
  root: process.env.BANK_ROOT || '/path/to/bank',
  port: process.env.PORT || 3000,
  logger: {
    level: process.env.LOG_LEVEL || 'info'
  }
};

Environment Variables

• BANK_ROOT: The root directory path of the memory bank.
• PORT: The port to which the server binds.
• LOG_LEVEL: The logging level (debug, info, warn, error, fatal).

💻 Usage Examples

Basic Usage

const { Bank } = require('memory-bank-mcp-server');

async function example() {
  const bank = new Bank({
    root: '/path/to/bank',
    logger: {
      level: 'debug'
    }
  });

  await bank.start();

  // Example operations
  await bank.deposit('key', 'value');
  const value = await bank.withdraw('key');
  console.log(value); // Output: value

  await bank.close();
}

example().catch(console.error);

🔧 Development

Install Dependencies

npm install

Start the Development Server

npm run dev

Build the Project

npm run build

🤝 Contribution

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

• Write all new code in TypeScript.
• Maintain type safety in the codebase.
• Write tests for new features.
• Update relevant documentation.
• Follow the existing code style and patterns.

Testing

• Write unit tests.
• Include tests for multi-project scenarios.
• Thoroughly test error cases.
• Validate type constraints.
• Appropriately mock file system operations.

📄 License

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

🙏 Acknowledgments

This project implements the memory bank concept originally documented by Cline Memory Bank and extends it with remote capabilities and multi-project support.