Remember Me

🚀 记住我

“记住我”是一个用于维护基于MCP的语言模型应用对话上下文和规则的持久框架，它能持久化存储和检索不同类型的资源，为语言模型应用提供有力的支持。

🚀 快速开始

运行服务器

使用MCP Inspector

1. 克隆仓库：

   git clone https://github.com/yourusername/memories.git
   cd memories
   

2. 安装依赖项：

   npm install
   

3. 启动开发服务器：

   npm run dev
   

配置LLM平台

将LLM配置为与“记住我”服务器通信。具体步骤取决于所选的LLM框架（例如，OpenAI、Hugging Face等）。

✨ 主要特性

“记住我”作为一个MCP服务器，旨在持久化存储和检索不同类型的资源：

• 规则：定义交互行为的约束和指导方针
• 片段：存储可重用的代码或文本片段
• 摘要：保存对话中的重要上下文信息

该系统使用SQLite进行持久化，并提供了一个全面的API来管理这些资源的不同上下文。

🔧 技术细节

架构

核心组件

• MyContext：所有持久操作的中央管理器
• PersistentResource：所有可存储资源的基础类
  • Rule：定义交互参数的命令
  • Snippet：代码或文本片段，可被引用
  • Summary：对话上下文信息
• Backup：用于创建和还原上下文状态的系统

数据模型

资源存储属性如下：

规则系统

规则采用结构化的策略框架：

• MUST：绝对要求
• MUST NOT：绝对禁止
• SHOULD：推荐做法
• SHOULD NOT：不鼓励的做法
• MAY：可选考虑因素

📚 详细文档

API

上下文管理

• my_context()：加载当前上下文，可附加额外上下文
• my_context_backup_create()：创建当前状态的备份
• my_context_backup_restore()：从之前的备份还原
• my_context_backup_list()：查看可用备份
• my_context_backup_remove()：删除特定备份
• my_context_backup_clear()：清除所有备份

规则管理

• my_context_rule_list()：列出上下文中的所有规则
• my_context_rule_set()：创建或更新一条规则
• my_context_rule_remove()：删除一条规则

片段管理

• my_context_snippet_list()：列出上下文中的片段
• my_context_snippet_get()：获取特定片段
• my_context_snippet_set()：创建或更新片段
• my_context_snippet_remove()：删除片段

摘要管理

• my_context_summary_list()：列出上下文中的摘要
• my_context_summary_get()：获取特定摘要
• my_context_summary_set()：创建或更新摘要
• my_context_summary_remove()：删除摘要

与LLMs结合使用

“me” 上下文

“me” 是一个特殊的默认上下文，始终可用。它包含应用于每次对话的全局规则、片段和摘要。

加载上下文

LLM应在对话开始时加载上下文。这会从“me”上下文中检索所有规则、片段和摘要。然后LLM应遵循返回的任何规则。

额外上下文

除了“me”，你可以通过指定额外上下文来加载其他上下文。例如：

• 一个“coding”上下文，包含编程相关片段
• 一个“creative”上下文，包含写作提示
• 一个“technical”上下文，包含专业知识

这些可以在需要时与默认的“me”上下文一起附加。