README
🚀 Obsidian Memory MCP
Obsidian Memory MCP 是一个 MCP 服务器,它将 AI 记忆存储为 Markdown 文件,以便在 Obsidian 的图谱视图中进行可视化展示。
🚀 快速开始
要使用 Obsidian Memory MCP,首先需要进行安装和配置。
安装步骤
git clone https://github.com/YuNaga224/obsidian-memory-mcp.git
cd obsidian-memory-mcp
npm install
npm run build
配置
在 Claude Desktop 中进行如下配置:
{
"mcpServers": {
"obsidian-memory": {
"command": "node",
"args": ["/full/path/to/obsidian-memory-mcp/dist/index.js"],
"env": {
"MEMORY_DIR": "/path/to/your/obsidian/vault"
}
}
}
}
使用方法
- 按照上述选项配置 Claude Desktop。
- 重启 Claude Desktop。
- 使用 MCP 记忆工具创建实体和关系。
- 打开 Obsidian 并查看图谱。
知识图谱将以如下方式可视化:
- 实体文件作为节点。
[[链接]]作为边。- 不同实体类型使用不同颜色(如果在 Obsidian 中进行了配置)。
✨ 主要特性
- Markdown 存储:为每个实体单独存储为
.md文件。 - Obsidian 集成:使用
[[链接]]语法进行图谱可视化。 - 知识图谱:存储实体、关系和观察信息。
- 搜索功能:可以对所有存储的记忆进行查询。
- YAML 前置元数据:元数据存储在前置元数据中。
📦 安装指南
克隆仓库
git clone https://github.com/YuNaga224/obsidian-memory-mcp.git
进入项目目录
cd obsidian-memory-mcp
安装依赖
npm install
构建项目
npm run build
配置 Claude Desktop
{
"mcpServers": {
"obsidian-memory": {
"command": "node",
"args": ["/full/path/to/obsidian-memory-mcp/dist/index.js"],
"env": {
"MEMORY_DIR": "/path/to/your/obsidian/vault"
}
}
}
}
💻 使用示例
基础用法
以下是一个实体文件(John_Doe.md)的示例:
---
entityType: person
created: 2025-07-10
updated: 2025-07-10
---
# John Doe
## Observations
- Works at Tech Corp
- Expert in TypeScript
- Lives in Tokyo
## Relations
- [[Manager of::Alice Smith]]
- [[Collaborates with::Bob Johnson]]
- [[Located in::Tokyo Office]]
高级用法
在开发过程中,可以使用以下命令监听文件变化并重新构建:
npm run watch # Watch for changes and rebuild
📚 详细文档
关于项目
本项目是 Anthropic 的记忆服务器 的修改版本,已针对 Obsidian 集成进行了调整。原始服务器以 JSON 格式存储记忆,而此版本将其存储为单独的 Markdown 文件,并使用与 Obsidian 兼容的 [[链接]] 语法进行图谱可视化。
与原始版本的主要区别
- 存储格式:从 JSON 更改为单独的 Markdown 文件。
- Obsidian 集成:添加了用于表示关系的
[[链接]]语法。 - YAML 前置元数据:元数据存储在前置元数据中,而不是 JSON 中。
- 文件结构:每个实体成为一个单独的
.md文件。 - 移除的功能:简化以专注于仅使用 Markdown 存储。
存储格式
每个实体都存储为一个单独的 Markdown 文件,包含:
- YAML 前置元数据:用于存储元数据(entityType、created、updated)。
- 与 Obsidian 兼容的
[[链接]]:用于表示关系。 - 组织好的部分:用于存储观察信息和关系。
📄 许可证
本项目采用 MIT 许可证,详情请参阅 LICENSE 文件。
原始记忆服务器:Copyright (c) 2024 Anthropic, PBC
Obsidian 集成修改:Copyright (c) 2025 YuNaga224
🔧 技术细节
API
服务器提供以下工具:
create_entities:创建新实体。create_relations:在实体之间创建关系。add_observations:向现有实体添加观察信息。delete_entities:删除实体及相关数据。delete_observations:移除特定的观察信息。delete_relations:移除关系。read_graph:获取整个知识图谱。search_nodes:通过查询搜索实体。open_nodes:按名称获取特定实体。
致谢
本项目基于 Model Context Protocol 服务器集合中的 Anthropic 的记忆服务器。感谢 Anthropic 在 MIT 许可证下发布原始实现。
扫码联系在线客服