lore-context

<div align="center"> # 工具列表 **人工智能代理内存、评估和治理的控制平面。** 了解每个代理记住、使用了什么以及应该忘记什么 - 在内存成为生产风险之前。 [](https://github.com/Lore-Context/lore-context/actions/workflows/ci.yml) [](LICENSE) [](CHANGELOG.md) [](CONTRIBUTING.md#dco-developer-certificate-of-origin) [](https://nodejs.org) [快速入门](docs/getting-started.md) · [网站快速入门](https://lorecontext.com/quickstart/) · [基准测试方法](https://lorecontext.com/benchmark/) · [API 参考](docs/api-reference.md) · [架构](docs/architecture.md) · [项目计划](docs/project-plan.md) · [发布状态](docs/release-status.md) · [路线图](docs/roadmap.md) · [集成](docs/integrations/README.md) · [部署](docs/deployment/README.md) · [更新日志](CHANGELOG.md) 🌐 **以您的语言阅读**: [English](README.md) · [简体中文](docs/i18n/zh-CN/README.md) · [繁體中文](docs/i18n/zh-TW/README.md) · [日本語](docs/i18n/ja/README.md) · [한국어](docs/i18n/ko/README.md) · [Tiếng Việt](docs/i18n/vi/README.md) · [Español](docs/i18n/es/README.md) · [Português](docs/i18n/pt/README.md) · [Русский](docs/i18n/ru/README.md) · [Türkçe](docs/i18n/tr/README.md) · [Deutsch](docs/i18n/de/README.md) · [Français](docs/i18n/fr/README.md) · [Italiano](docs/i18n/it/README.md) · [Ελληνικά](docs/i18n/el/README.md) · [Polski](docs/i18n/pl/README.md) · [Українська](docs/i18n/uk/README.md) · [Bahasa Indonesia](docs/i18n/id/README.md) Localized docs may lag the current English release notes; the canonical v2.1 docs are the English README and `docs/` set. </div> --- ## 什么是 Lore Context Lore Context 是一个 **开源核心控制平面**，用于 AI 代理内存：它在内存、搜索、存储库图和工具轨迹中组合上下文；在您自己的数据集上评估检索质量；为敏感内容路由治理审查；并将内存作为可移植的交换格式导出，您可以在后端之间移动它。 它并不试图成为另一个内存数据库。独特的价值在于内存之上构建的内容： - **上下文查询** - 单个端点组合内存 + 网络 + 存储库 + 工具轨迹，返回具有来源的评分上下文块。 - **内存评估** - 在您拥有的数据集上运行 Recall@K、Precision@K、MRR、stale-hit-rate、p95 延迟；持久运行并区分它们以检测回归。 - **治理审查** - 六状态生命周期（`候选 / 活动 / 标记 / 编辑 / 替换 / 删除`），风险标签扫描，毒性启发式，immutable 审计日志。 - **类似 MIF 的可移植性** - JSON + Markdown 导出/导入，保留 `来源 / 有效性 / 置信度 / 来源引用 / 替换 / 矛盾`。作为内存后端之间的迁移格式。 - **存储库图** - 确定性存储库索引（文件、符号、导入、调用、路由、测试）作为 API 路由和只读 MCP 工具公开，以便代理在稳定的项目上下文契约中定位存储库答案。 - **多代理适配器** - 一流的 `agentmemory` 集成，带有版本探测 + 降级模式备用；用于附加运行时的干净适配器契约。 ## 何时使用 | 使用 Lore Context 当... | 使用内存数据库（agentmemory、Mem0、Supermemory）当... | |---|---| | 您需要 **证明** 您的代理记得什么、为什么以及是否使用过 | 您只需要原始内存存储 | | 您运行多个代理（Claude Code、Cursor、Qwen、Hermes、Dify）并希望共享可信赖的上下文 | 您正在构建单个代理，并且可以接受供应商锁定的内存层 | | 您需要本地或私有部署以满足合规性要求 | 您更喜欢托管的 SaaS | | 您需要在您自己的数据集上进行评估，而不是供应商基准 | 供应商基准足以提供信号 | | 您想在系统之间迁移内存 | 您不计划更换后端 | ## 快速入门 ```bash # 1. 克隆 + 安装 git clone https://github.com/Lore-Context/lore-context.git cd lore-context && pnpm install # 2. 运行快速入门助手并检查激活报告 pnpm quickstart -- --dry-run --activation-report # 3. 生成一个真实的 API 密钥（在本地开发环境以外，不要使用占位符） export LORE_API_KEY=$(openssl rand -hex 32) # 4. 启动 API（基于文件，无需 Postgres） pnpm build && PORT=3000 LORE_STORE_PATH=./data/lore-store.json pnpm start:api # 5. 编写内存 curl -H "Authorization: Bearer $LORE_API_KEY" -H "Content-Type: application/json" \ -X POST http://127.0.0.1:3000/v1/memory/write \ -d '{"content":"使用 RDS 作为真实存储，使用 Qdrant 作为 Lore Context 生产的派生召回索引。","memory_type":"project_rule","project_id":"demo"}' # 6. 查询上下文，然后检查证据账本中的返回的 traceId curl -H "Authorization: Bearer $LORE_API_KEY" -H "Content-Type: application/json" \ -X POST http://127.0.0.1:3000/v1/context/query \ -d '{"query":"生产存储","project_id":"demo","token_budget":1200}' ``` 有关公共网站快速入门，请参见 [lorecontext.com/quickstart](https://lorecontext.com/quickstart/)。有关完整 设置（Postgres、Docker Compose、仪表板、MCP 集成），请参见 [docs/getting-started.md](docs/getting-started.md)。 规范的 alpha 快速入门是 `git clone` + `pnpm quickstart`。Lore 目前不发布或声称公共的 `@lore-context/quickstart` npm 包。 MCP stdio 服务器作为单独的 [`@lore-context/server`](https://www.npmjs.com/package/@lore-context/server) 发布，用于注册和客户端分发，SDK 中间件作为 [`@lore-context/sdk-middleware`](https://www.npmjs.com/package/@lore-context/sdk-middleware) （npm）和 `lore-context-middleware`（PyPI）发布。 ## 架构 下图显示了完整的开源核心加上托管生产的形状。在 公共 OSS 仓库中，直接支持本地文件/Postgres 部署；托管 Google 签名、AWS SQS 工作线程、私有嵌入、计费和多租户 操作是商业托管云表面。 ```text ┌───────────────────────────────────────────────┐ MCP/REST 客户端 ─► │ apps/api （身份验证 + 速率限制 + 证据） │ （Claude Code、 │ ├── 内存收件箱 / 生命周期 / 审计 │ Codex、Cursor、 │ ├── 捕获摄入 + 召回水化 │ OpenCode...） │ ├── 上下文查询（内存/网络/存储库/轨迹） │ │ ├── 存储库图查询 / 符号 / 影响 │ │ ├── Google 签名 + 托管 MCP 元数据 │ │ └── OpenAPI + 使用 + 操作员表面 │ └───────────────┬───────────────────────────────┘ │ 捕获 / 嵌入 / 图作业 ▼ ┌───────────────────────────────────────────────┐ │ memory-worker （AWS SQS + DLQ 扇出） │ │ ├── 自动编辑 / 审查 / 保存 │ │ ├── 梦想管家（修剪/合并/解决） │ │ ├── 私有 Qwen3 嵌入服务 │ │ └── Qdrant 密集 + 稀疏索引 │ └───────────────┬───────────────────────────────┘ │ ┌────────────────────┼────────────────────┐ ▼ ▼ ▼ RDS PostgreSQL 16 Qdrant 派生索引 apps/dashboard 真实存储 + 审计 lore_memories_v12 用户面向 SaaS ``` 有关详细信息，请参见 [docs/architecture.md](docs/architecture.md)。 ## v2.1.0 新增功能 `v2.1.0` 是 **存储库图 API 和 MCP 工具** 版本。它使 Lore 自己的 存储库图成为一流的代理内存表面：用于文件、符号、导入、调用、 路由、测试和过程提示的确定性 TypeScript/JavaScript 存储库索引， 通过 API 路由和只读 MCP 工具公开，以便代理在稳定的项目上下文契约中定位存储库答案。 v2.1.0 是当前的开源源代码线。托管的 Lore Cloud 生产 线也运行 v2.1.0，基于商业 AWS/Qdrant/私有嵌入基板， 但托管操作、计费、生产发布自动化和机密保管 运行时保留在 `Lore-Context/lore-cloud` 中。 | 功能 | 状态 | 位置 | |---|---|---| | 存储库图 API + MCP 工具（`repo.graph_query` / `symbol_context` / `impact` / `detect_changes`） | ✅ 开源 + 托管生产 | `packages/repo-graph`, `apps/api`, `apps/mcp-server` | | 代码知识图索引器 | ✅ 开源 + 托管生产 | `packages/code-indexer`, `packages/code-indexer-python` | | 上下文查询组合内存 + 网络 + 存储库 + 工具轨迹 | ✅ 开源 + 托管生产 | `apps/api`, `docs/api-reference.md` | | 7 流 `HybridSearchOrchestrator`（FTS / pgvector / Qdrant 密集 + 稀疏 / 图 / 时间 / 维基） | ✅ 开源 + 托管生产 | `packages/search` | | 跨编码器重新排序器（后融合，可选） | ✅ 开源，需要提供商密钥 | `apps/api/src/rerankers/` | | 梦想管家内存整合（修剪/合并/解决/表面） | ✅ 开源，标志门控 | `apps/api/src/workers/butler-v18.ts` | | 代理内存自我改进循环 + 上下文配方 | ✅ 开源，人类门控提升 | `packages/eval`, `packages/search` | | SDK 中间件（自动注入 + 自动保留 OpenAI / Anthropic 客户端） | ✅ 已发布 | `packages/sdk-middleware-typescript`, `packages/sdk-middleware-python` | | 生成的 SDK 源预览 | ✅ 开源预览 | `packages/sdk-python`, `packages/sdk-go`, `packages/sdk-java`, `packages/sdk-dotnet` | | 浏览器扩展捕获脚手架 | ✅ 开源脚手架 | `apps/browser-extension` | | AI 代理机密保管（MCP 原生，三按钮授权） | 托管测试中，等待加密审计 | 商业运行时在 `Lore-Context/lore-cloud` | | 云内存引擎：RDS 真实存储 + SQS 工作线程扇出 + Qdrant 索引 | 托管生产 | 商业托管云 | | 私有 Qwen3-Embedding-0.6B 1024 维向量服务 | 托管生产 | 商业托管云 | | 自动捕获摄入和内存收件箱异常 | ✅ 开源 + 托管生产 | `apps/api`, `packages/capture`, `apps/dashboard` | | Google 签名 + 个人保管启动 | 托管生产 | 商业托管云 | | 商业 SaaS：个人订阅、计费、配额门控 | 托管生产 | `Lore-Context/lore-cloud` | | REST API 具有 API 密钥身份验证（读取者/写入者/管理员） | ✅ 开源 + 托管生产 | `apps/api` | | OpenAPI 3.1 合同在 `/openapi.json`（报告 `2.1.0`） | ✅ 开源 + 托管生产 | `apps/api/src/openapi.ts` | | MCP stdio 服务器（旧版 + 官方 SDK 传输） | ✅ 开源 + 托管生产 | `apps/mcp-server` | | Next.js 仪表板客户工作流程脚手架 | ✅ 开源脚手架 + 托管生产 | `apps/dashboard` | | 证据账本 API + 仪表板摘要 | ✅ 开源 + 托管生产 | `apps/api`, `apps/dashboard` | | 治理状态机 + 审计日志 | ✅ 开源 + 托管生产 | `packages/governance` | | 评估运行器（Recall@K / Precision@K / MRR / staleHit / p95） | ✅ 开源 + 托管生产 | `packages/eval` | | MIF v0.2 导入/导出，带有 `supersedes` + `contradicts` | ✅ 开源 | `packages/mif` | | 模型网关（多提供商任务→模型路由） | ✅ 开源 | `packages/model-gateway` | | `agentmemory` 适配器，带有版本探测 + 降级模式 | ✅ 开源 | `packages/agentmemory-adapter` | | 速率限制、结构化 JSON 日志记录和字段编辑 | ✅ 开源 + 托管生产 | `apps/api` | | Docker Compose 私有部署 | ✅ 开源自托管 | `docker-compose.yml`, `docs/deployment/` | | `pnpm quickstart` 本地采用助手 + 激活报告 | ✅ 开源 | `scripts/lore-quickstart.mjs` | | 官方 MCP 注册表 + 分发 / 启动 / 设计合作伙伴文档 | ✅ 开源文档 | `server.json`, `docs/distribution/`, `docs/launch/` | 有关完整的发布历史，请参见 [CHANGELOG.md](CHANGELOG.md)。 ## 当前发布状态 `v2.1.0` 是当前的源代码、托管生产和发布线。它部署 到 AWS 生产环境和公共网站，通过优化的发布流程： 不可变的 arm64-first 构件、暂存 API 烟雾测试、生产 API 部署、 隔离的网站部署、发布后审计和标签/发布关闭。外部 检查确认 `https://api.lorecontext.com/health` 返回 `status=ok`， `/openapi.json` 报告 `2.1.0`，并且 `https://lorecontext.com/status.html` 包含 `v2.1.0`。 生产环境保留 v1.1+ RDS / SQS / memory-worker / Qdrant 云形状， 使用 `lore_memories_v12` 作为 Qdrant 集合，保留 1024 维 pgvector 用于 Postgres 路径，并添加存储库图模式 （`apps/api/src/db/schema-v21-repo-graph.sql`）。 有关当前的公共安全 状态快照，请参见 [docs/release-status.md](docs/release-status.md)， 有关完整的发布说明，请参见 [docs/release-notes/v2.1.0.md](docs/release-notes/v2.1.0.md)。 ## 发布重点 v2.1 版本使 Lore 的存储库图成为一流的代理内存 表面。目标是让代理回答“X 在哪里定义”，“什么调用 这个”，以及“如果我更改这个，什么会中断”针对确定性、稳定的 项目上下文契约，而不是临时文本搜索： - `@lore/repo-graph` - 用于文件、符号、导入、调用、 路由、测试和过程提示的确定性 TypeScript/JavaScript 存储库索引。 - API 路由：`POST /v1/repo/graph/query`，`POST /v1/repo/symbol/context`， `POST /v1/repo/impact`，和 `POST /v1/repo/detect-changes`。 - MCP 工具：`repo.graph_query`，`repo.symbol_context`，`repo.impact`，和 `repo.detect_changes`（只读）。 - `context_query(repo)` 现在在可用时使用提供者支持的存储库图证据， 并在存储库图存储未配置时进行诚实的不可用回退。 - 存储库图 Postgres 模式是累加的 - 它位于现有的 生产模式之上，并在生产/暂存模式设置期间应用。 根包和 API 包版本报告 `2.1.0`，因此 `/openapi.json` 与 发布标签匹配。发布列车使用在 v2.0.9 之后引入的优化的 分开 API/网站部署防护。 有关详细信息，请参见 [docs/project-plan.md](docs/project-plan.md)、 [docs/roadmap.md](docs/roadmap.md) 和 [docs/release-governance.md](docs/release-governance.md)。 ## 集成 Lore Context 支持 MCP 和 REST，并与大多数代理 IDE 和聊天前端集成： | 工具 | 安装指南 | |---|---| | Claude Code | [docs/integrations/claude-code.md](docs/integrations/claude-code.md) | | Cursor | [docs/integrations/cursor.md](docs/integrations/cursor.md) | | Qwen Code | [docs/integrations/qwen-code.md](docs/integrations/qwen-code.md) | | OpenClaw | [docs/integrations/openclaw.md](docs/integrations/openclaw.md) | | Hermes | [docs/integrations/hermes.md](docs/integrations/hermes.md) | | Dify | [docs/integrations/dify.md](docs/integrations/dify.md) | | FastGPT | [docs/integrations/fastgpt.md](docs/integrations/fastgpt.md) | | Cherry Studio | [docs/integrations/cherry-studio.md](docs/integrations/cherry-studio.md) | | Roo Code | [docs/integrations/roo-code.md](docs/integrations/roo-code.md) | | OpenWebUI | [docs/integrations/openwebui.md](docs/integrations/openwebui.md) | | 其他 / 通用 MCP | [docs/integrations/README.md](docs/integrations/README.md) | ## 部署 | 模式 | 使用场景 | 文档 | |---|---|---| | **本地文件备份** | 独立开发、原型设计、烟雾测试 | 本 README，快速入门上方 | | **本地 Postgres+pgvector** | 单节点本地备用和迁移测试 | [docs/deployment/README.md](docs/deployment/README.md) | | **Docker Compose 私有** | 自托管团队部署，隔离网络 | [docs/deployment/compose.private-demo.yml](docs/deployment/compose.private-demo.yml) | | **托管云** | RDS / SQS / memory-worker / Qdrant / 私有嵌入以及图增强的混合召回堆栈和商业 SaaS 基板 | [docs/release-status.md](docs/release-status.md) | 所有部署路径都需要显式机密。本地/私有路径需要 `POSTGRES_PASSWORD`，`LORE_API_KEYS` 和仪表板身份验证。托管部署还需要 RDS、SQS、Qdrant、嵌入服务、OAuth、隧道配置和生产运行时导出。 `scripts/check-env.mjs` 脚本在任何值与占位符模式匹配时都会拒绝生产启动。 ## 安全 v2.1.0 版本保持本地/私有部署姿态和托管云的防护措施，以适用于普通用户访问： - **身份验证**：使用带有角色分离（`reader`/`writer`/`admin`）和按项目范围的 API-key 承载令牌。空令牌模式在生产环境中失败关闭。 - **速率限制**：每 IP + 每密钥双桶，带有身份验证失败回退（60 秒内 5 次失败后返回 429，30 秒锁定）。 - **仪表盘**：托管产品使用 Google 会话流；本地/私有运营商部署仍然使用 HTTP 基本身份验证。 - **容器**：所有 Dockerfile 以非 root `node` 用户运行；API 和仪表盘启用 HEALTHCHECK。 - **密钥**：零硬编码凭证；所有默认值均为必填或失败变量。`scripts/check-env.mjs` 在生产环境中拒绝占位符值。 - **治理**：写入时进行 PII / API 密钥 / JWT / 私钥正则表达式扫描；风险标记的内容自动路由到审查队列；每次状态转换都有不可变的审计日志。 - **内存中毒**：基于共识 + 命令动词模式的启发式检测。 - **MCP**：每个工具输入使用 zod 模式验证；变异工具需要 `reason`（≥8 个字符）并显示 `destructiveHint: true`；上游错误在客户端返回前进行净化。 - **工作隔离**：捕获、嵌入、图、连接器和回填作业通过带有 DLQ 的 AWS SQS 队列运行；Qdrant 是一个派生索引，RDS 仍然是权威的。 - **日志记录**：结构化 JSON 自动隐藏 `content`、`query`、`memory`、`value`、`password`、`secret`、`token`、`key` 字段。 漏洞披露：[SECURITY.md](SECURITY.md)。 ## 项目结构 ```text apps/ api/ # REST 控制平面 + Postgres + 治理 + 评估 + 仓库图 dashboard/ # Next.js 仪表盘脚手架；托管 Google 会话适用于商业版本 mcp-server/ # MCP stdio 服务器（旧版 + 官方 SDK 传输） cli/ # lore CLI（doctor, wiki-recompile, 数据集导入/导出） browser-extension/ # 捕获表面脚手架 web/ # 服务器端 HTML 渲染器（无 JS 备用 UI） website/ # 营销网站（单独处理） packages/ shared/ # 共享类型、错误、ID/令牌实用程序 agentmemory-adapter # 连接到上游 agentmemory + 版本探测 search/ # 7 流 HybridSearchOrchestrator + 配方适配器 repo-graph/ # 确定性仓库索引（v2.1） code-indexer/ # 代码知识图索引器（TypeScript/JavaScript） code-indexer-python # 代码知识图索引器（Python） capture/ # 捕获摄入基元 connectors/ # 外部源连接器 model-gateway/ # 多提供商任务→模型路由 mif/ # 内存交换格式（v0.2） eval/ # EvalRunner + 度量基元 + 上下文配方 governance/ # 状态机 + 风险扫描 + 中毒 + 审计 profile/ # 保险箱 / 账户配置文件类型 sdk-typescript/ # TypeScript 客户端 SDK sdk-python/ # Python 客户端 SDK sdk-go/ sdk-java/ sdk-dotnet/ # 其他语言 SDK sdk-middleware-typescript/ # 自动注入 + 自动保留中间件（npm） sdk-middleware-python/ # 自动注入 + 自动保留中间件（PyPI） docs/ i18n/<lang>/ # 17 种语言的本地化 README integrations/ # 代理-IDE 集成指南 deployment/ # 本地和 Docker Compose 私有部署文档 legal/ # 隐私 / 条款 / Cookie（新加坡法律） scripts/ check-env.mjs # 生产模式环境验证 smoke-*.mjs # 端到端烟雾测试 apply-postgres-schema.mjs ``` ## 要求 - Node.js `>=22` - pnpm `10.30.1` - （可选本地回退）Postgres 16 带有 pgvector - （托管/高级）RDS PostgreSQL 16，AWS SQS，Qdrant 和私有嵌入服务 ## 贡献 欢迎贡献。请阅读 [CONTRIBUTING.md](CONTRIBUTING.md) 以了解开发工作流、提交消息协议和审查期望。 有关文档翻译，请参阅 [i18n 贡献者指南](docs/i18n/README.md)。 ## 运营商 Lore Context 由 **REDLAND PTE. LTD.**（新加坡，UEN 202304648K）运营。公司简介、法律条款和数据处理在 [`docs/legal/`](docs/legal/) 中有文档记录。 ## 许可证 Lore Context 仓库在 [Apache License 2.0](LICENSE) 下获得许可。`packages/*` 下的各个软件包声明 MIT 许可证，以便于下游使用。请参阅 [NOTICE](NOTICE) 以了解上游归属。 ## 致谢 Lore Context 在 [agentmemory](https://github.com/agentmemory/agentmemory) 的基础上作为本地内存运行时构建。上游合同详细信息和版本兼容性政策在 [UPSTREAM.md](UPSTREAM.md) 中有文档记录。