Memory PouchDB

🚀 Custom Memory Service: PouchDB 🧠

This project adds new features to the Memory server provided by the MCP team. It allows the creation and management of knowledge graphs, capturing interactions through large language models (LLMs). 🚀

This project is forked from https://github.com/BRO3886/mcp-memory-custom. Thanks for fixing the timestamp issue. The main goal of this repository is to solve the problem of continuously growing JSON files in the context.

✨ Features

1. PouchDB Integration 💾

• The server now uses PouchDB for robust document storage.
• Why? Better data consistency, built - in version control, and improved performance for large datasets.
• Maintain file backups for compatibility.

2. Custom Memory File Path 📁

• Support for custom memory file paths.
• Why? Provides greater flexibility and the ability to adapt to different storage requirements.

3. Error Recovery ✨

• Enhanced error handling mechanism for more stable operation.
• Why? Ensures quick recovery in the face of errors and maintains service availability.

🚀 Quick Start

🛠️ Prerequisites

• Node.js and npm are installed.
• Familiarity with command - line operations.

📦 Installation

1. Clone the repository:

git clone https://github.com/yourusername/mcp-memory-pouchdb.git
cd mcp-memory-pouchdb

2. Install dependencies:

npm install

🛡️ Configuration

• Set environment variables:

  export MEMORY_FILE_PATH=/path/to/your/memoryfile.json
  

• Initialize the database:

  npm run init-db
  

💻 Usage Examples

💽 Running the Server

1. Build the project:

npm run build

2. Start the service:

node dist/index.js

🔧 Core Tools

• Get current time ⏰
• Set memory file path 📁
• Create entity ➕
• Create relation 🔗
• Add observation 📝
• Delete entity ❌
• Delete observation 🗑️
• Delete relation 🔗
• Read graph 📖
• Search node 🔍
• Open node 🔓

💡 Important Note

• All operations follow user privacy and data protection policies.
• Data persistence is achieved through PouchDB, ensuring data security and reliability.

🛠️ Basic Usage

// Create an entity
createEntity({
  id: 'user123',
  properties: {
    name: '张三',
    age: 28,
    role: 'Developer'
  }
});

// Create a relation
createRelation({
  from: 'user123',
  to: 'project456',
  type: 'Participate'
});

// Add an observation
addObservation({
  entityId: 'project456',
  content: 'The project is expected to be completed next month',
  timestamp: getCurrentTime()
});

🙏 Acknowledgments

• Thanks to Anthropic's Memory server for inspiration.
• Powered by PouchDB for robust data storage 💾