Memory Bank MCP Server

🚀 Memory Bank MCP Server

A memory bank server based on the MCP protocol, supporting multi-project isolation and Markdown format document management, suitable for large language model (LLM) tool calls.

🚀 Quick Start

The Memory Bank MCP Server is a powerful tool designed to manage multiple projects with Markdown documents and integrate seamlessly with large language models (LLMs) using the MCP protocol. This guide will walk you through the installation, configuration, and usage of the server.

✨ Features

• MCP Protocol Compliance: Fully adheres to the Model Context Protocol (MCP) specification, enabling direct invocation by large language models.
• Multi-Project Isolation: Supports isolated management of multiple projects, with separate storage for each project's tasks, progress, and other information.
• Markdown Format: All project documents are stored in Markdown format, facilitating easy editing and maintenance.
• Web Interface: Provides an intuitive Web management interface for viewing and editing project documents.
• Flexible Rule System: Supports the setting of global rules and project-specific rules, with project rules taking precedence over global rules.
• Import and Export Functionality: Supports data import and export at the project level.
• Database-Free: Utilizes the file system for storage, reducing deployment complexity.

📦 Installation

Prerequisites

• Node.js 16+ (recommended 18+)
• npm 7+ or yarn 1.22+

Steps

1. Clone the repository

git clone https://github.com/your-username/memory-bank-mcp-server.git
cd memory-bank-mcp-server

2. Install dependencies

npm install

3. Build the project

npm run build

4. Start the server

# Start both Web and MCP servers
npm start

# Start only the Web server
npm start -- web

# Start only the MCP server
npm start -- mcp

Environment Variables

You can configure the server by creating a .env file or setting environment variables:

PORT=3000           # Web server port
ROOT_DIR=/app/data  # Data storage root directory
SESSION_SECRET=your-secret-key  # Session secret key

💻 Usage Examples

Basic Usage

Here's how you can use the Memory Bank MCP Server with a large language model:

// Example of listing projects using the MCP interface
const mcpClient = new MCPClient('http://localhost:3000');
mcpClient.list_projects().then(projects => {
    console.log('Projects:', projects);
});

Advanced Usage

For more complex scenarios, you can use the server's REST API to manage projects, documents, and rules:

// Example of creating a new project using the REST API
fetch('/api/projects', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        name: 'New Project',
        description: 'This is a new project'
    })
})
.then(response => response.json())
.then(data => console.log(data));

📚 Documentation

Architecture Design

The Memory Bank MCP Server employs a modular design, consisting of the following main components:

• MCP Server: Implements the MCP protocol and provides tool interfaces for LLM calls.
• Web Server: Offers REST APIs and a front-end interface.
• File Storage System: Utilizes JSON and Markdown files for data persistence.
• Project Management System: Isolates data and rules for different projects.

Data Storage

The server uses the file system for data storage, with the following main files and directories:

data/
├── projects.json           # Project metadata
├── documents.json          # Document metadata
├── rules.json              # Rule metadata
├── projects/               # Project file directory
│   ├── {project-id}/       # Single project directory
│   │   ├── projectbrief.md # Project overview
│   │   ├── activeContext.md # Current context
│   │   ├── tasks.md        # Task list
│   │   └── ...             # Other documents
├── templates/              # Document template directory

Markdown File Format

Project documents are stored in Markdown format. Here are some common document types:

• projectbrief.md - Project Overview

# Project Overview

## Project Name

## Objectives

## Requirements

## Technology Stack

## Timeline

• tasks.md - Task Tracking

# Tasks

## To-Do Tasks

- [ ] Task 1
- [ ] Task 2

## In-Progress Tasks

- [ ] Task 3

## Completed Tasks

- [x] Task 4

API Reference

The server provides the following main API interfaces:

Project Management

• GET /api/projects - Get all projects
• GET /api/projects/:id - Get project details
• POST /api/projects - Create a new project
• PUT /api/projects/:id - Update a project
• DELETE /api/projects/:id - Delete a project

Document Management

• GET /api/projects/:projectId/documents - Get the project document list
• GET /api/projects/:projectId/documents/:type - Get document content
• PUT /api/projects/:projectId/documents/:type - Update document content

Rule Management

• GET /api/projects/:projectId/rules - Get the project rule list
• GET /api/rules/:id - Get rule content
• POST /api/rules - Create a new rule
• PUT /api/rules/:id - Update a rule
• DELETE /api/rules/:id - Delete a rule

MCP Tool Interfaces

The server provides the following MCP tool interfaces for large model calls:

• list_projects - Get all projects
• create_project - Create a new project
• update_project - Update project information
• delete_project - Delete a project
• list_documents - Get the project document list
• get_document - Get document content
• update_document - Update document content
• list_rules - Get the project rule list
• get_rule - Get rule content
• create_rule - Create a new rule
• update_rule - Update rule content
• delete_rule - Delete a rule

Using with Cursor

Configuration Steps

1. Start the MCP server

npm start -- mcp

2. Open the settings in Cursor and find "AI Settings".
3. Add a custom tool provider in the "Tool Providers" section:
   • Name: Memory Bank
   • Description: Multi-project Markdown document management tool
   • Command: node [Your installation path]/memory-bank-mcp-server/dist/index.js mcp
   • Check "Enable".
4. Save the settings and restart Cursor.
5. Now you can use commands like this in Cursor to call Memory Bank:

Use Memory Bank to create a new project named "My Project" with the description "This is my first project".

Differences and Improvements from cursor-memory-bank

Compared with the original cursor-memory-bank project, the main differences and improvements of this project include:

1. MCP Protocol Support: Implements the complete MCP protocol, allowing direct invocation by large models.
2. Multi-Project Isolation: Supports managing multiple projects, each with independent documents and rules.
3. Web Interface: Provides a visual Web management interface.
4. Rule System: Supports setting global rules and project-specific rules.
5. More Flexible Document Management: Supports custom document types and templates.
6. Modular Design: Adopts a modular architecture for easy expansion and maintenance.

Best Practices

• Document Naming: Use clear and consistent naming conventions for each document.
• Project Structure: Create a consistent document structure for each project.
• Rule Management: Set general rules in global rules and specific project rules in project rules.
• Regular Backups: Regularly export project data for backup.
• Markdown Format: Utilize Markdown's formatting features, such as headings, lists, and tables, to make documents more structured.

Notes

• File modifications take effect immediately without restarting the server.
• Deleting a project will delete all its documents and rules, and this operation is irreversible.
• The project ID cannot be changed after creation.
• Document content is stored using UTF-8 encoding.

Troubleshooting

• MCP Server Connection Failure: Check if the command path is correct and ensure the server is running.
• Web Interface Access Failure: Check if the port is occupied and ensure the server is running.
• Document Save Failure: Check file system permissions and ensure the directory is writable.
• Project Import Failure: Check if the import file format is correct.

Future Plans

• Add a user authentication system.
• Support real-time collaborative editing.
• Increase more document type templates.
• Support document version history.
• Add a search function.
• Support more import/export formats.

📄 License

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

🔧 Contribution

We welcome issue reports, feature suggestions, and code contributions. Please create an issue first to discuss the changes you want to make.