关于 memograph
MemoGraph 将 Markdown 笔记整理为持久化知识图谱,供个人、团队和 AI Agent 使用。它结合关键词、语义与图遍历检索,并提供 CLI、Web UI 和 MCP 服务。
主要功能
- 01基于 Markdown 的记忆库
- 02关键词、语义与图混合检索
- 03自动构建 wikilink 图谱
- 04AI 标签与链接建议
- 05CLI 和图谱浏览 Web UI
适用场景
- 01跨 AI 对话回忆决策
- 02通过近似表述查找笔记
- 03发现主题缺口和薄弱关联
MCP 相关
其 stdio MCP 服务提供搜索、创建、更新和关联记忆等工具,并支持自主记忆管理。只读模式可禁用写入工具。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
uvx memographMEMOGRAPH_VAULTPath to your MemoGraph vault directory (created if missing).MEMOGRAPH_READONLYSet to 'true' to block destructive MCP tools (delete_memory, update_memory, bulk_create, batch_delete, batch_update). Recommended for shared or untrusted clients.MEMOGRAPH_PROVIDEROptional LLM provider for query_with_context tool. Only needed if you want AI-generated answers.MEMOGRAPH_MODELOptional LLM model name (e.g. 'claude-sonnet-4-6'). Used together with MEMOGRAPH_PROVIDER.ANTHROPIC_API_KEY密钥API key for Anthropic Claude. Required when MEMOGRAPH_PROVIDER=claude or when using the [anthropic] extra.OPENAI_API_KEY密钥API key for OpenAI. Required when using the [openai] extra (embeddings or LLM).OLLAMA_HOSTBase URL for a local Ollama server (default http://localhost:11434). Only needed when MEMOGRAPH_PROVIDER=ollama or the [ollama] extra is installed.本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。
工具
39收录的工具列表 · 更新于 2 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| tags | array | 否 | 用于筛选的可选标签 |
| query | string | 是 | 搜索查询字符串 |
| top_k | number | 否 | 结果数量上限(默认值:8) |
| memory_type | enum | 否 | 可选的记忆类型筛选条件episodic | semantic | procedural | fact |
详细介绍
MemoGraph 🧠
**MemoGraph 可将一组 Markdown 笔记转化为可查询、适用于 AI 的知识图谱。**它解决了大模型的记忆难题——AI 助手会忘记上周二的决定,找不到两个项目中的相关笔记,还会一遍遍重新推导相同的见解——为它们提供一个持久、可浏览、便于追溯来源的记忆层,并将其保存在由你掌控的纯 Markdown 文件中。
你可以像往常一样写笔记。MemoGraph 会为笔记建立索引,从 [[wikilinks]] 构建图谱,按重要性排序,并按需将内容提供给你的大模型(或团队)。
⚡ 60 秒快速体验
pip install memograph
memograph quickstart
就这么简单。quickstart 命令会在你的磁盘上创建一个小型、互相关联的示例知识库(包含 15 篇关于 Python 开发的笔记,彼此之间带有真实的维基链接),为其建立索引,并运行三个实时演示查询,让你在决定是否采用前,先体验图谱和混合检索的效果。尤其可以试试这个查询:
memograph --vault ~/memograph-quickstart search "FastAPI dependency injection"
知识库中有一篇标题为 FastAPI dependencies 的笔记(介绍 Depends(...))——没有任何笔记的标题包含“dependency”或“injection”这两个词。MemoGraph 仍能找到它,因为混合检索可以从语义上理解“dependency injection”,而维基链接图谱则将相关笔记串联起来。一个查询,就能展示产品的核心能力。
随时重新运行 memograph quickstart --force,即可重置为全新的演示环境。准备好后,将 MemoGraph 指向你的真实笔记:memograph --vault ~/your-notes ingest。
你将获得
作为个人用户 / 知识工作者
- 由人类可读的 Markdown 文件组成的知识库——没有专有格式,也没有供应商锁定。无论使用什么工具,你的笔记都能长久留存。
- 混合检索结合关键词搜索、语义相似度和图遍历,即使你不记得确切用词,也能找到正确的笔记。
- AI 辅助标记、链接建议和知识缺口检测,帮助你的知识库不断成长,而不是逐渐荒废。
- 用于浏览、编辑和可视化图谱的命令行界面和 Web UI。
作为 AI Agent / IDE 用户
- 功能完备的 模型上下文协议(MCP)服务,提供 30 多种工具,开箱即用,兼容 Claude Desktop、Claude Code、Cursor、Cline、Windsurf、Continue、Zed、VS Code、Goose、Gemini CLI、OpenAI Codex CLI 等。
- 自主“自动保存”钩子,可自动将 AI 对话中的决定和上下文保存到知识库。
- 按对话回忆记忆——你的助手可以直接调取“我们上周关于 X 做了什么决定”,无需你每次都复制粘贴上下文。
作为企业 / SaaS 运营方
- 多租户部署:按租户进行文件系统级隔离,提供端到端隔离测试和预热 LRU 内核缓存。
- OIDC + API 密钥身份验证:支持 JWKS(Auth0、Clerk、WorkOS、Keycloak、Azure AD、Okta),并提供限制性 CORS、请求大小上限和速率限制。
- 符合 GDPR 的定时删除:采用带宽限期的墓碑标记流程,自动执行最终备份,配备每日清理器,并记录每次删除的审计日志。
- 内置可观测性:OpenTelemetry 跟踪 + Prometheus
/metrics、带请求 ID 的结构化 JSON 日志,以及用于编排的独立/healthz//readyz。 - 随代码提供运维手册:包括安装、SSO 设置、RBAC、备份还原和 GDPR 流程。
使用者如何受益
| 你想要…… | MemoGraph 为你提供…… |
|---|---|
| 防止 AI 助手在不同对话间遗忘上下文 | 持久化知识库 + MCP 服务,以及可选的自动保存钩子 |
| 只记得一点线索,却要在成千上万条笔记中找到一条 | 混合检索(关键词 + 语义 + 图谱),并按显著性排序 |
| 无需手动交叉链接即可关联相关想法 | AI 链接建议、反向链接图、BFS 遍历 |
| 发现知识库中缺少的内容 | 缺口检测器 + 主题聚类 + 学习路径建议 |
| 为团队或产品自托管记忆后端 | Web UI、FastAPI HTTP API、OpenAPI v1 契约、Docker compose |
| 将 MemoGraph 部署给多个付费客户 | 多租户内核注册表、OIDC、配额(路线图)、GDPR 运维手册 |
| 应对 SOC 2 审计沟通 | 绑定用户和租户的审计日志、可观测性、安全工作流、合规路线图文档 |
✨ 功能一览
核心记忆引擎
- 基于图谱的记忆 — 双向
[[wikilinks]]可自动构建可导航的知识图谱。 - 混合检索 — 结合关键词、语义嵌入和图谱遍历,并重新排序。
- 受认知科学启发的记忆类型:情景、语义、程序、事实。
- 显著性评分(0–1):随时间衰减,并在访问时提升。
- 智能索引 — 缓存 mtime,仅重新解析发生变化的文件。
- 上下文压缩 — 根据大模型提示词的令牌预算进行窗口化处理。
- 原生 Markdown 知识库 — 每条记忆都是带有 YAML frontmatter 的
.md文件;无需专有格式。
AI 功能
- 智能自动整理引擎 — 从记忆中提取主题、人物、行动项、决策、问题、情绪、风险、想法和时间线事件。
- AutoTagger — 通过语义分析、结构检测和模式学习来建议标签。
- LinkSuggester — 为相关笔记建议
[[wikilinks]];也会提供双向链接建议。 - GapDetector — 揭示缺失的主题、覆盖薄弱之处、孤立笔记和未建立的链接。
- 知识分析 — 知识库统计、主题聚类、学习路径和关联分析。
接口
- Python API —
MemoryKernel支持同步、异步和批处理版本。 - CLI — 提供 24+ 条命令,用于摄取、搜索、批量操作、导入、导出、备份和 AI 功能。
- MCP 服务 — 提供 30+ 个工具,使用 stdio 传输,可直接接入任何兼容 MCP 的客户端。
- Web UI — 提供 React + D3 图谱可视化、搜索和编辑功能(FastAPI 后端 + Vite 前端)。
- HTTP API — 采用版本化
/api/v1/,在 CI 中提供 OpenAPI 快照,可用于服务间集成。
企业级与 SaaS 就绪
- 多租户,采用文件系统隔离租户、LRU 热内核注册表、每租户审计日志,并通过端到端隔离测试作为发布门槛。
- 身份验证,支持通过 OIDC(JWKS)或哈希 API 密钥进行身份验证;按路由设置身份验证范围;将身份绑定到审计日志中。
- Web 加固——严格限制 CORS、slowapi 速率限制、请求大小上限、包含请求 ID 的结构化 JSON 日志,以及不泄露信息的 500 错误处理程序。
- 存储加固——防路径遍历的保险库写入、保险库大小软性/硬性上限、带架构版本的缓存文件。
- 计划删除,满足 GDPR 第 17 条要求:使用可配置宽限期的墓碑标记、自动执行最终备份、每日清理脚本,以及宽限期结束前取消的端点。
- 可观测性——OpenTelemetry FastAPI/asyncio 自动检测、Prometheus
/metrics、OTLP 导出。 - 可靠性——并发审计、并发写入压力测试、带完整性检查的版本化备份格式。
- 分发——固定并锁定依赖项、用于自托管的 Docker compose、安全工作流(
bandit+pip-audit)。
有关面向运维人员的详细信息,请参阅 docs/INSTALL_ENTERPRISE.md、docs/SSO_SETUP.md、docs/GDPR_RUNBOOK.md、docs/BACKUP_RESTORE_RUNBOOK.md、docs/OBSERVABILITY_GUIDE.md 和 docs/RBAC_GUIDE.md。
🚀 快速开始
想自行托管? docs/HOSTING_GUIDE.md 介绍了四种真正免费的方案:Oracle Free Tier、Cloudflare Tunnel + 你的硬件(推荐给大多数用户)、GCP 始终免费 方案,以及将 GitHub 仓库用作保险库。通过 OIDC 实现工作区身份验证,以及 将 Drive 用作可移植备份的说明,请参阅 docs/GOOGLE_WORKSPACE_SETUP.md。
安装
pip install memograph
安装可选依赖项:
# For OpenAI support
pip install memograph[openai]
# For Anthropic Claude support
pip install memograph[anthropic]
# For Ollama support
pip install memograph[ollama]
# For embedding support
pip install memograph[embeddings]
# Install everything
pip install memograph[all]
Python 用法
from memograph import MemoryKernel, MemoryType
# Initialize the kernel attached to your vault path
kernel = MemoryKernel("~/my-vault")
# Ingest all notes in the vault
stats = kernel.ingest()
print(f"Indexed {stats['indexed']} memories.")
# Programmatically add a new memory
kernel.remember(
title="Meeting Note",
content="Decided to use BFS graph traversal for retrieval.",
memory_type=MemoryType.EPISODIC,
tags=["design", "retrieval"]
)
# Retrieve context for an LLM query
context = kernel.context_window(
query="how does retrieval work?",
tags=["retrieval"],
depth=2,
top_k=8
)
print(context)
🔌 MCP 服务(模型上下文协议)
MemoGraph 提供功能完整的 MCP 服务,可与 Cline 和 Claude Desktop 等 AI 助手无缝集成。
📖 初次接触 MemoGraph MCP? 请参阅 MCP 用户指南,了解实用的使用说明和示例!
🚨 遇到连接问题? 请参阅 设置与故障排除指南,了解“无法连接”错误的常见解决方法!
19 种可用工具
| 类别 | 工具 | 描述 |
|---|---|---|
| 搜索 | search_vault, query_with_context | 语义搜索和上下文检索 |
| 创建 | create_memory, import_document | 添加记忆并导入文档 |
| 读取 | list_memories, get_memory, get_vault_info | 浏览和检索记忆 |
| 更新 | update_memory | 修改现有记忆 |
| 删除 | delete_memory | 按 ID 删除记忆 |
| 分析 | get_vault_stats | 保险库统计数据和洞察 |
| 发现 | list_available_tools | 列出所有可用工具 |
| 自主 | auto_hook_query, auto_hook_response, configure_autonomous_mode, get_autonomous_config | 自主记忆管理 |
| 图谱 | relate_memories, search_by_graph, find_path | 基于图谱的关联与遍历 |
| 批量 | bulk_create | 一次调用创建多条记忆 |
支持的客户端
MemoGraph 的 MCP 服务是 stdio 服务,可与任何兼容 MCP 的 Agent CLI 或编辑器一同运行。完整的配置指南(配置文件路径、格式差异、验证步骤)请参阅 docs/MCP_CLIENTS.md:
| 客户端 | 格式 | 快速参考 |
|---|---|---|
| Claude Code(CLI) | mcpServers | claude_code_config.json |
| Claude Desktop | mcpServers | claude_desktop_config.json |
| Cline | mcp.servers | cline_config.json |
| Cursor | mcpServers | cursor_config.json |
| Windsurf | mcpServers | windsurf_config.json |
| Continue.dev | experimental.modelContextProtocolServers | continue_config.json |
| Zed | context_servers | zed_config.json |
| VS Code(1.99+) | servers | vscode_config.json |
| Goose(Block) | YAML extensions | goose_config.yaml |
| Roo Code | mcpServers | roo_code_config.json |
| Gemini CLI | mcpServers | gemini_cli_config.json |
| OpenAI Codex CLI | TOML mcp_servers.<name> | codex_config.toml |
| LM Studio | mcpServers | lm_studio_config.json |
| Cherry Studio | UI 表单 | cherry_studio_config.json |
| IBM Bob Shell | mcpServers | bob_shell_config.json |
启动 MCP 服务
执行 pip install memograph(或 uv tool install memograph)后,以下三个启动命令的效果完全相同:
memograph-mcp # console script (recommended)
python -m memograph.mcp.run_server # module form (works with any Python)
uvx --from memograph memograph-mcp # zero-install via uv
memograph-mcp 和 memograph 都注册为控制台脚本:前者启动 MCP 服务,后者是 CLI。两者不会冲突。
只读模式
对于共享部署或不受信任的客户端,请设置 MEMOGRAPH_READONLY=true。服务会拒绝所有写入知识库的工具——create_memory、import_document、update_memory、delete_memory、relate_memories、bulk_create、batch_update、batch_delete、import_backup_tool 以及自动保存钩子——并改为返回结构化的 {"success": false, "readonly": true, "error": "..."} 负载。读取工具(search_vault、query_with_context、list_memories、get_memory、分析、图遍历)仍可正常使用。
Claude Desktop 快速设置
将以下内容添加到 claude_desktop_config.json:
{
"mcpServers": {
"memograph": {
"command": "memograph-mcp",
"env": {
"MEMOGRAPH_VAULT": "/path/to/your/vault"
}
}
}
}
如果客户端的 PATH 中找不到 memograph-mcp 二进制文件(客户端启动时未加载你的 shell 环境的情况很常见),请改用显式模块形式:
{
"mcpServers": {
"memograph": {
"command": "python",
"args": ["-m", "memograph.mcp.run_server"],
"env": {
"MEMOGRAPH_VAULT": "/path/to/your/vault"
}
}
}
}
Cline 快速设置
将以下内容添加到 ~/.cline/mcp_settings.json:
{
"mcp": {
"servers": {
"memograph": {
"command": "memograph-mcp",
"env": {
"MEMOGRAPH_VAULT": "/path/to/your/vault"
}
}
}
}
}
有关 Claude Code、Cursor、Windsurf、Continue、Zed、VS Code、Goose、Gemini CLI、Codex CLI、LM Studio、Cherry Studio 和 Bob Shell,请参阅 docs/MCP_CLIENTS.md。
从 MCP Registry 安装
新增:MemoGraph 现已收录于官方 MCP Registry!🎉
Registry URL:https://github.com/modelcontextprotocol/servers/tree/main/src/memograph
pip install memograph
然后将适用于你所用客户端的代码片段放入其配置文件中(参见上表或 docs/MCP_CLIENTS.md)。
在 MCP Registry 中收录的好处:
- ✅ 由 Anthropic、GitHub 和 Microsoft 支持的官方注册表
- ✅ 所有兼容 MCP 的客户端均可发现
- ✅ 经验证的服务卡片和元数据
- ✅ 可直接链接到 PyPI 软件包
- ✅ 受到 MCP 社区信赖
注意:Registry 使用 PyPI 软件包版本。运行 pip install memograph 时,会自动获取 Registry 收录的最新版本。
完整的提交和配置指南请参见 MCP_REGISTRY_GUIDE.md。
使用示例
配置完成后,使用自然语言与 AI 助手交互:
"Search my vault for memories about Python"
"Create a memory titled 'Project Ideas' with content '...'"
"Update memory abc-123 to have salience 0.9"
"Delete memory xyz-456"
"What tools are available?"
"Get vault statistics"
完整的 MCP 配置指南请参见 CONFIG_REFERENCE.md。
使用自动保存钩子
MemoGraph 提供自主钩子,可自动保存对话:
- ⚠️ 重要:钩子是被动工具——请参阅自主钩子指南了解设置方法
- 📝 快速修复:为 Claude Desktop 添加自定义指令(指南中提供了说明)
- 🔧 使用
MEMOGRAPH_AUTONOMOUS_MODE=true进行配置
🎯 CLI 用法
MemoGraph 附带功能强大的 CLI,可用于管理知识库并与其对话。
导入
将 Markdown 文件索引到图数据库中:
memograph --vault ~/my-vault ingest
强制重新索引所有文件:
memograph --vault ~/my-vault ingest --force
记忆
通过命令行快速添加记忆:
memograph --vault ~/my-vault remember \
--title "Team Sync" \
--content "Discussed Q3 goals." \
--tags planning q3
上下文窗口
为查询生成上下文:
memograph --vault ~/my-vault context \
--query "What did we decide about the database?" \
--tags architecture \
--depth 2 \
--top-k 5
提问(交互式聊天)
基于知识库上下文开启交互式聊天会话:
memograph --vault ~/my-vault ask --chat --provider ollama --model llama3
或者提出单个问题:
memograph --vault ~/my-vault ask \
--query "Summarize our design decisions" \
--provider claude \
--model claude-3-5-sonnet-20240620
诊断
检查环境以及与大模型提供方的连接:
memograph --vault ~/my-vault doctor
### Import Documents
Import documents (TXT, PDF, DOCX) and convert them to markdown:
```bash
# Import a single file
memograph --vault ~/my-vault import document.pdf --type episodic
# Import entire folder
memograph --vault ~/my-vault import ~/Documents --recursive
# Preview files without importing (dry run)
memograph --vault ~/my-vault import ~/Documents --dry-run
# Auto-ingest after import
memograph --vault ~/my-vault import document.pdf --auto-ingest
批量操作
高效地一次管理多条记忆:
# Bulk create memories from JSON/CSV
memograph --vault ~/my-vault batch-create memories.json
# Bulk update memories by filter
memograph --vault ~/my-vault batch-update \
--filter-tags outdated \
--add-tags reviewed \
--salience 0.8
# Bulk delete with safety checks
memograph --vault ~/my-vault batch-delete \
--filter-type episodic \
--filter-max-salience 0.3 \
--dry-run
数据管理
导出、备份和恢复知识库:
# Export vault to JSON/CSV/Markdown
memograph --vault ~/my-vault export --format json --output backup.json
# Create timestamped backup
memograph --vault ~/my-vault backup --output ./backups
# Restore from backup
memograph --vault ~/my-vault import-backup backup.zip
配置与统计
管理设置并查看知识库分析数据:
# View vault statistics
memograph --vault ~/my-vault stats
# Configure settings
memograph config set embedding_provider openai
memograph config get embedding_provider
memograph config list
# Manage profiles
memograph config profile create work --vault ~/work-vault
memograph config profile use work
MCP 设置
通过交互式向导为 Claude Desktop 或 Cline 配置 MCP 服务:
# Run interactive setup wizard
memograph setup-mcp
# Verify MCP configuration
memograph verify-mcp
**📖 完整 CLI 文档:**详细文档及涵盖全部 24 条命令的 200 多个示例,请参见 CLI 使用指南。
🤖 AI 功能
MemoGraph 包含强大的 AI 功能,可增强知识管理工作流。完整文档请参见 AI 功能指南。
🏷️ AutoTagger — 智能标签建议
通过语义分析、内容结构和现有模式,自动建议相关标签:
# Suggest tags for a note
memograph suggest-tags note.md
# Apply high-confidence suggestions automatically
memograph suggest-tags note.md --apply
# Adjust confidence threshold and limit
memograph suggest-tags note.md --min-confidence 0.5 --max-suggestions 10
**功能:**基于频率的提取 • 语义相似度 • 结构检测 • 模式学习 • 置信度评分
🔗 LinkSuggester — 智能维基链接推荐
通过语义相似度和图分析,智能推荐指向相关笔记的维基链接:
# Suggest links for a note
memograph suggest-links note.md
# Apply suggestions automatically
memograph suggest-links note.md --apply
# Show bidirectional link opportunities
memograph suggest-links note.md --show-bidirectional
**功能:**语义搜索 • 关键词匹配 • 基于图的建议 • 双向检测 • 目标预览
🔍 GapDetector — 知识库分析
识别知识库中缺失的主题、覆盖薄弱的领域和孤立笔记:
# Detect all gaps
memograph detect-gaps
# Focus on high-severity gaps
memograph detect-gaps --min-severity 0.7
# Export results to JSON
memograph detect-gaps --output json > gaps.json
**缺口类型:**缺失主题 • 覆盖薄弱 • 孤立笔记 • 缺失链接
📊 知识分析 — 全面洞察
全面分析整个知识库:
# Full analysis with all features
memograph analyze-knowledge
# Export detailed report to JSON
memograph analyze-knowledge --output json > analysis.json
**分析内容:**知识库统计 • 主题聚类 • 学习路径 • 缺口检测 • 关联分析
AI 功能的 Python API
from memograph import MemoryKernel
from memograph.ai import AutoTagger, LinkSuggester, GapDetector
kernel = MemoryKernel("~/my-vault")
kernel.ingest()
# Get tag suggestions
tagger = AutoTagger(kernel, min_confidence=0.4)
suggestions = await tagger.suggest_tags(
content="Python is great for data science",
title="Data Science with Python"
)
# Get link suggestions
suggester = LinkSuggester(kernel, min_confidence=0.5)
links = await suggester.suggest_links(
content="Python async programming tutorial",
title="Async Python"
)
# Detect knowledge gaps
detector = GapDetector(kernel, min_severity=0.5)
gaps = await detector.detect_gaps()
# Comprehensive analysis
analysis = await detector.analyze_knowledge_base()
📖 完整文档:
- AI 功能指南 - 包含示例的全面指南
- Web UI 指南 - 在浏览器中使用 AI 功能
- MCP AI 工具指南 - 面向 Claude 和 Cline 的 AI 功能
💡 使用场景: 自动整理笔记 • 发现关联 • 找出缺漏 • 保持一致性 • 构建学习路径
📖 核心概念
记忆类型
MemoGraph 支持受认知科学启发的不同记忆类型:
- 情景记忆:个人经历和事件(例如,会议笔记)
- 语义记忆:事实和通用知识(例如,文档)
- 程序记忆:操作方法和流程知识(例如,教程)
- 事实记忆:离散的事实信息(例如,配置值)
图遍历
该库使用 BFS(广度优先搜索)遍历知识图谱:
# Retrieve nodes with depth=2 (2 hops from seed nodes)
nodes = kernel.retrieve_nodes(
query="graph algorithms",
depth=2, # Traverse up to 2 levels deep
top_k=10 # Return top 10 relevant memories
)
显著性评分
每条记忆都有一个显著性评分(0.0-1.0),用于表示其重要性:
---
title: "Critical Architecture Decision"
salience: 0.9
memory_type: semantic
---
We decided to use PostgreSQL for better ACID guarantees...
🏗️ 项目结构
MemoGraph/
├── memograph/ # Main package
│ ├── core/ # Core functionality
│ │ ├── kernel.py # Memory kernel
│ │ ├── graph.py # Graph implementation
│ │ ├── retriever.py # Hybrid retrieval
│ │ ├── indexer.py # File indexing
│ │ └── parser.py # Markdown parsing
│ ├── adapters/ # LLM and embedding adapters
│ │ ├── embeddings/ # Embedding providers
│ │ ├── frameworks/ # Framework integrations
│ │ └── llm/ # LLM providers
│ ├── storage/ # Storage and caching
│ ├── mcp/ # MCP server implementation
│ └── cli.py # CLI implementation
├── tests/ # Test suite
├── examples/ # Example usage
└── scripts/ # Utility scripts
🤝 贡献
欢迎贡献!详情请参阅贡献指南。
开发环境设置
-
克隆仓库:
git clone https://github.com/Indhar01/MemoGraph.git cd MemoGraph -
以开发模式安装:
pip install -e ".[all,dev]" -
安装 pre-commit 钩子:
pre-commit install -
运行测试:
pytest
代码质量
我们坚持高标准的代码质量:
- Lint 检查:使用 Ruff 快速检查 Python 代码
- 代码格式化:使用 Ruff formatter 保持代码风格一致
- 类型检查:使用 MyPy 进行静态类型分析
- 测试:使用 Pytest 进行全面的测试覆盖
- Pre-commit 钩子:在每次提交前自动运行检查
📚 文档
入门指南
- 托管指南 - 💸 免费托管选项(Oracle Free Tier、Cloudflare Tunnel、GCP、GitHub-vault),附带加固检查清单
- Google Workspace 设置 - 🔐 OIDC 身份验证 + Drive 可移植性备份
- MCP 客户端指南 - 🔌 15+ 个 Agent CLI/编辑器的配置片段(Claude Code、Cursor、Windsurf、Continue、Zed、VS Code、Goose、Gemini CLI、Codex CLI、LM Studio 等)
- MCP 用户指南 - ⭐ 从这里开始! MemoGraph MCP 完整使用指南
- 设置与故障排除 - 🚨 无法连接? 连接问题的分步修复指南
- MCP 测试指南 - 设置后测试 MCP 服务
面向开发者和贡献者
- MCP Registry 指南 - 发布到官方 MCP Registry
- 版本策略 - 语义化版本控制与发布规划
- AGENTS.md - AI Agent 使用此代码库的指南
- 贡献指南 - 如何为项目做出贡献
- 行为准则 - 社区准则
- 安全策略 - 安全问题报告与最佳实践
- 变更日志 - 版本历史与变更
🔒 安全
漏洞报告方式请参阅我们的安全策略。
📄 许可证
本项目采用 MIT 许可证授权,详情请参阅 LICENSE 文件。
🌟 致谢
本项目的灵感源于改善大模型应用中的记忆管理需求。项目基于以下内容构建:
- 基于图的知识表示
- 混合检索策略
- 认知科学原理
📬 联系与支持
📣 社区与反馈
我们重视社区反馈和贡献!以下是参与方式:
报告问题
发现 Bug 或有功能请求?在 GitHub 上提交问题。
讨论
加入 GitHub Discussions 参与交流:
- 提出问题
- 分享用例
- 提出改进建议
- 展示你构建的内容
贡献
欢迎贡献!请参阅我们的贡献指南,了解以下方面的详情:
- 代码贡献
- 文档改进
- Bug 报告和功能请求
- 社区支持
获取最新动态
- ⭐ 在 GitHub 为仓库加星标
- 👁️ 关注更新和发行版本
- 📦 在 PyPI 关注项目
- 🔗 查看 MCP Registry 条目
🚦 状态
当前版本:0.3.0
单租户部署稳定,推荐用于生产环境。 多租户部署的功能已完备,发布前需通过端到端隔离测试; 公共 API 将在 v1.0 时趋于稳定。
- ✅ 核心功能稳定且经过测试(安全、契约和租户测试套件共 172+ 项测试)
- ✅ 使用 MyPy 对整个软件包进行类型检查
- ✅ Ruff lint + format + pre-commit 钩子
- ✅ CI 中包含 OpenAPI v1 契约快照
- ✅ 通过端到端测试套件验证多租户隔离不变量
- ⚠️ v1.0.0 之前,公共 API 可能会在次要版本中发生变化
最近发布的内容
- Phase 3.7 — 符合 GDPR 的计划租户删除:带宽限期的墓碑机制、每日清理器、自动最终备份。
- Phase 3.5 — 将
TenantRegistry接入请求路径;非管理员路由会按租户解析其内核。 - Phase 3 脚手架 — 多租户 ADR、
TenantStorage、TenantRegistry、用于租户生命周期管理的管理员路由。 - Phase 2 — OpenTelemetry + Prometheus、结构化 JSON 日志、并发审计、压力测试。
- Phase 1 — OIDC + API 密钥身份验证、slowapi 速率限制、限制性 CORS、请求大小上限、知识库大小上限、架构版本化缓存、OpenAPI v1 契约、安全测试套件。
- Phase 0 — 防路径遍历的知识库写入、不泄露信息的错误处理程序、固定依赖项、Docker compose、安全 CI 工作流。
- 📦 已发布至官方 MCP Registry(io.github.indhar01/memograph)
用 ❤️ 打造,助力更好地管理大模型记忆
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。