Cline Memory Bank

🚀 Cline Memory Bank Integration Guide

This guide provides a comprehensive overview of integrating the Cline Memory Bank into your project, including installation steps, usage examples, and best practices.

📦 Installation

Run the following command in the root directory of your project to initialize the Memory Bank:

use_mcp_tool('memory-bank', 'initialize_memory_bank', {
  projectPath: process.cwd()
});

The file structure after initialization is as follows:

your-project/
├── memory-bank/
│   ├── activeContext.md      # Current context file
│   ├── progress.md           # Progress tracking file
│   ├── decisionLog.md       # Decision log file
│   └── projectContext.md    # Project context file

💻 Usage Examples

Basic Usage

Initialize a New Memory Bank

use_mcp_tool('memory-bank', 'initialize_memory_bank', {
  projectPath: process.cwd()  // Or specify a path
});

Access Project Context

access_mcp_resource('memory-bank', 'memory://project/context');

Advanced Usage

Update the Current Context

use_mcp_tool('memory-bank', 'update_context', {
  projectPath: process.cwd(),
  content: {
    currentSession: {
      date: new Date().toISOString().split('T')[0],
      mode: 'development',
      task: 'Description of the current task'
    }
  }
});

Record Technical Decisions

use_mcp_tool('memory-bank', 'record_decision', {
  projectPath: process.cwd(),
  decision: {
    title: 'Decision title',
    description: 'Content of the decision',
    rationale: 'Reason for the decision'
  }
});

📚 Documentation

File Structure

After initialization, the Memory Bank creates the following file structure in the project root directory:

graph LR
    根目录[Project Root Directory] --> 银行[memory-bank]
    银行 --> PC[projectContext.md]
    银行 --> AC[activeContext.md]
    银行 --> P[progress.md]
    银行 --> DL[decisionLog.md]
    PC --> Stack[Technology Stack]
    AC --> Tasks[Active Tasks]
    P --> Status[Project Status]
    DL --> History[Decision History]

Initial File Content

1. activeContext.md:

   • Current session information (date, mode, task)
   • Open questions
   • Latest updates section

2. progress.md:

   • Current phase (initialization phase)
   • Completed tasks
   • In-progress tasks
   • Obstacle tracking

3. decisionLog.md:

   • Project structure decisions
   • Development process selection
   • Documentation strategy decisions
   • Pending decisions section

4. projectContext.md:

   • Project overview and version information
   • Technology stack and dependencies
   • List of configuration files
   • Architectural principles
   • Development setup guide
   • Project workflow specifications

Using Cline Integration

Workflow Diagram

graph LR
    Start[Start] --> Init[Initialize]
    Init --> Context[Load Context]
    Context --> Update[Make Changes]
    Update --> Progress[Track Progress]
    Progress --> Record[Record Decisions]
    Record --> Sync[Auto-sync]
    Sync --> Context

Development

To modify or enhance the server:

1. Navigate to the Cline project directory.
2. Install dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

Contribution Guidelines

1. Fork this repository to your account.
2. Create a new branch in your repository:

   git checkout -b feature/your-feature-name
   

3. Commit your code changes:

   git add .
   git commit -m "Add feature: Your commit message"
   

4. Push the branch to the remote repository:

   git push origin feature/your-feature-name
   

5. Create a Pull Request to the main branch.

System Prompt

In your code editor, paste the following content into the src/memory-bank.ts file:

export function initializeMemoryBank(projectPath: string): void {
  // Initialization logic
}

export function updateContext(content: any): void {
  // Context update logic
}

🔧 Technical Details

Core Features

1. Context Management: Track information about the current development session.
2. Progress Tracking: Record the project's progress status.
3. Decision Logging: Save important technical decisions.
4. Project Configuration: Maintain basic project information and architectural principles.

Key Advantages

• Improve development efficiency.
• Enhance code maintainability.
• Reduce the risk of knowledge loss.
• Improve team collaboration.

Best Practices

1. Update the context file before each commit.
2. Regularly review the decision log.
3. Reference relevant records in project documentation.
4. Use version control to track all changes.