Basic Memory

🚀 Basic Memory

Welcome to Basic Memory, a desktop application built using MCP (Model Context Protocol). It's designed to enhance the AI-driven research and writing experience. By integrating Claude Desktop and VS Code, this tool simplifies and streamlines information organization.

✨ Features

• Real-time Synchronization: Claude Desktop can directly access your knowledge base.
• Multi-format Support: Supports file types such as Markdown and text.
• Tag System: Facilitates quick content classification and retrieval.
• Version Control: Records each update for easy backtracking.
• Project Management: Supports the creation of independent knowledge bases.

📦 Installation

Using VS Code

Add the following configuration to your user settings (in JSON format):

{
  "mcp": {
    "servers": {
      "basic-memory": {
        "command": "uvx",
        "args": ["basic-memory", "mcp"]
      }
    }
  }
}

Or add it to the .vscode/mcp.json file in your workspace:

{
  "servers": {
    "basic-memory": {
      "command": "uvx",
      "args": ["basic-memory", "mcp"]
    }
  }
}

Configuring Claude Desktop

Edit the Claude Desktop configuration file (usually located at ~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "basic-memory": {
      "command": "uvx",
      "args": [
        "basic-memory",
        "mcp"
      ]
    }
  }
}

💻 Usage Examples

Basic Usage

• Create a note: Use the write_note function to record your ideas.
• Read a note: View the content by title or permalink using read_note.
• Build context: Navigate the knowledge graph with the build_context function.
• Search notes: Find information in the knowledge base using search_notes.
• Check recent activity: Review your past work with recent_activity.

Advanced Usage

“Create a project record about our architectural decisions”
“Find information about JWT authentication”
“Generate a knowledge graph visualization of project components”
“Read my notes on the authentication system”
“What have I worked on this week?”

📚 Documentation

For more information, please refer to the official documentation, including:

• Complete User Guide
• CLI Tool Reference
• Multi-project Management
• Data Import

📄 License

AGPL-3.0

Contributions are welcome. Check out the Contribution Guide to learn how to set up the project locally and submit a PR.

Star History

Crafted with enthusiasm by Basic Machines