内容
<h1 align="center">记忆基因引擎</h1>
<p align="center">
<a href="https://www.rust-lang.org/"><img alt="Rust 1.95+" src="https://img.shields.io/badge/Rust-1.95%2B-b45309?style=flat-square&logo=rust&logoColor=white"></a>
<a href="LICENSE"><img alt="Apache 2.0" src="https://img.shields.io/badge/license-Apache--2.0-15803d?style=flat-square"></a>
<a href="docs/ARCHITECTURE.md"><img alt="本地优先的记忆" src="https://img.shields.io/badge/local--first-memory-0e7490?style=flat-square"></a>
<a href="docs/ARCHITECTURE.md"><img alt="二进制存储" src="https://img.shields.io/badge/binary-storage-6d28d9?style=flat-square"></a>
<a href="docs/INTEGRATION.md"><img alt="CLI TUI MCP" src="https://img.shields.io/badge/CLI%20.%20TUI%20.%20MCP-0369a1?style=flat-square"></a>
<a href="docs/SECURITY.md"><img alt="加密存储" src="https://img.shields.io/badge/encrypted-stores-15803d?style=flat-square"></a>
<a href="docs/INTEGRATION.md"><img alt="Python TypeScript SDK" src="https://img.shields.io/badge/Python%20.%20TypeScript-SDK-2563eb?style=flat-square"></a>
<br>
<sub><a href="https://github.com/ECD5A/Memory-Genome-Engine/blob/main/README.ru.md">俄语版本</a></sub>
</p>
记忆基因引擎为人工智能代理提供持久的、本地优先的项目记忆,使它们能够在不需要云服务或向量数据库的情况下跨会话回忆记忆。它存储类型化的 `MemoryCell` 记录,用 `MarkerGenome` 描述它们,将冷记忆移动到密封的二进制页面,并返回任务相关的 `ContextPacket` 输出。
<p align="center">
<img src="assets/mge-console-demo-en.gif" alt="记忆基因引擎终端仪表盘" width="100%">
</p>
## 功能
- 记住事实、决定、偏好、笔记和代理观察。
- 将最近的记忆存储在快速的L1热RAM中,具有持久的二进制持久性。
- 将较旧的记忆密封到不可变的二进制页面中,并具有候选索引。
- 支持聚焦、广泛和全范围的回忆。
- 导入现有的Markdown笔记作为一次性迁移输入,并支持软记忆状态维护。
- 提供CLI、TUI、MCP兼容的stdio服务器、Python SDK和TypeScript SDK。
- 支持选择加入的加密存储,用于热负载、快照和密封的页面负载。
- 使用二进制运行时存储;JSON仅用于协议/调试报告输出。
## 为什么选择MGE
MGE将代理记忆视为一个可检查的本地子系统,而不是不透明的聊天历史或托管搜索功能:
- `MarkerGenome` 明确保持范围、类型、状态、信任、敏感性、主题和自定义标记。
- 热到密封的生命周期将即时RAM回忆与持久的、可验证的二进制存储相结合。
- `ContextPacket` 返回排名记忆以及约束、警告和分数细节,供代理工作流使用。
- CLI、MCP兼容的stdio和薄SDK公开了相同的Rust引擎,无需云服务、嵌入式模型或向量数据库。
基于标记的检索是确定性和轻量级的,但它不是通用的语义搜索。查询锚和摄入质量很重要,默认回忆排名候选者而不是自动放弃。代理主机可以選擇 `--min-score` / `min_score` 以静默代替弱匹配。 [测量证据和局限性](docs/RELEASE.md#external-retrieval-evidence) 单独记录。
## 测量证据
本地发布模式检索运行使用严格的top-5评分和官方数据集文件,这些文件在存储库外部提供:
| 数据集 / 默认确切聚焦路径 | 记忆 | Hit@5 | Recall@5 | MRR@5 |
|---|---:|---:|---:|---:|
| LongMemEval Oracle | 4,578 | 0.972 | 0.877 | 0.775 |
| LongMemEval-S | 85,253 | 0.896 | 0.782 | 0.701 |
| LoCoMo | 5,881 | 0.531 | 0.487 | 0.393 |
这些测量值来自确定性适配器,而不是最终的LLM答案质量或优于其他产品的质量。数据集修订、校验和、摄入规则、BM25诊断、上下文预算测量和限制在 [发布](docs/RELEASE.md#external-retrieval-evidence) 中。
## 快速开始
使用 [快速入门](QUICKSTART.md) 安装校验发布的版本,然后初始化存储并可选地连接本地代理主机:
```bash
mge setup
mge setup codex
mge setup claude-code
mge setup cursor
mge remember "用户偏好简洁的技术答案" --kind user_preference --scope global --trust user_confirmed
mge recall "代理如何回答技术问题?"
mge seal
mge validate --deep
```
`mge setup codex`、`mge setup claude-code` 和 `mge setup cursor` 为这些主机注册本地 `mge-mcp-server`。`mge setup generic-mcp` 打印其他工具的可移植_stdio配置。
终端UI:
```bash
mge tui
mge setup --help
```
## 加密存储
```bash
export MGE_PASSPHRASE="使用真正的秘密"
mge init --encrypted --passphrase-env MGE_PASSPHRASE
mge remember "私人记忆" --passphrase-env MGE_PASSPHRASE
mge recall "私人记忆" --passphrase-env MGE_PASSPHRASE
mge seal --passphrase-env MGE_PASSPHRASE
mge validate --deep --passphrase-env MGE_PASSPHRASE
```
有效载荷加密保护热记录、快照和密封的页面有效载荷。元数据如标记字典、索引、目录摘要、Markdown导出和进程内存(在解锁时)按设计保持明文。参见 [安全](docs/SECURITY.md)。
## 代理集成
代理可以通过CLI命令、MCP兼容的stdio服务器或薄SDK包装器使用相同的本地存储。
CLI回忆:
```bash
mge recall "项目上下文" --mode broad --scope my_project
```
适用于任何兼容主机的MCP stdio服务器:
```bash
mge-mcp-server --store .memory-genome
```
SDK示例:
```bash
python examples/python_agent_host.py
node examples/typescript_agent_host.ts
```
参见 [集成](docs/INTEGRATION.md) 以获取加密主机设置、模式、结构化错误和SDK详细信息。
## 文档
- [快速入门](QUICKSTART.md)
- [架构](docs/ARCHITECTURE.md)
- [安全模型](docs/SECURITY.md)
- [集成 / MCP / SDK](docs/INTEGRATION.md)
- [发布检查](docs/RELEASE.md)
## 社区
- [许可证](LICENSE)
- [通知](NOTICE)
- [安全策略](SECURITY.md)
- [贡献](CONTRIBUTING.md)
- [行为准则](CODE_OF_CONDUCT.md)
## 捐赠
如果记忆基因引擎对您的工作有帮助,您可以通过以下方式支持该项目:
- 比特币(BTC):`1ECDSA1b4d5TcZHtqNpcxmY8pBH1GgHntN`
- USDT(TRC20):`TUF4vPdB6QkjCvZq18rBL4Qj4dK5ihCN75`
## 联系
对于商业集成、支持、合作和合作伙伴查询:
<p>
<a href="mailto:stelmak159@gmail.com" aria-label="电子邮件"><img alt="电子邮件" height="24" src="https://cdn.simpleicons.org/gmail/EA4335"></a>
<a href="https://t.me/ECDS4" aria-label="电报"><img alt="电报" height="24" src="https://cdn.simpleicons.org/telegram/26A5E4"></a>
<a href="https://github.com/ECD5A/Memory-Genome-Engine" aria-label="GitHub仓库"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cdn.simpleicons.org/github/FFFFFF"><img alt="GitHub仓库" height="24" src="https://cdn.simpleicons.org/github/181717"></picture></a>
</p>