README
🚀 Obsidian MCP 服务器
一个 MCP(模型上下文协议) 服务器,让 AI 助手能够与 Obsidian 笔记库进行交互,提供了读取、创建、编辑和管理笔记及标签的工具,极大提升笔记管理效率。
🚀 快速开始
此 MCP 服务器可使 AI 助手与 Obsidian 笔记库交互。在使用前,请确保满足相关要求,并依据安装步骤完成配置。
✨ 主要特性
- 🔍 读取和搜索笔记
- 📝 创建新笔记和目录
- ✏️ 编辑现有笔记
- 🚚 移动和删除笔记
- 🏷️ 管理标签(添加、移除、重命名)
- 🔎 搜索 vault 内容
📦 安装指南
手动安装
将以下内容添加到您的 Claude Desktop 配置中:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"obsidian": {
"command": "npx",
"args": ["-y", "obsidian-mcp", "/path/to/your/vault", "/path/to/your/vault2"]
}
}
}
将 /path/to/your/vault 替换为您 Obsidian 笔记库的绝对路径。例如:
macOS/Linux:
"/Users/username/Documents/MyVault"
Windows:
"C:\\Users\\username\\Documents\\MyVault"
保存配置后重新启动 Claude,您应该会看到锤子图标出现,表示服务器已连接。
如果遇到连接问题,请检查日志:
- macOS:
~/Library/Logs/Claude/mcp*.log - Windows:
%APPDATA%\Claude\logs\mcp*.log
通过 Smithery 安装
注意:我与 Smithery 无关。我尚未测试过使用它,建议用户尽量手动安装。
要通过 Smithery 自动为 Claude Desktop 安装 Obsidian:
npx -y @smithery/cli install obsidian-mcp --client claude
🔧 技术细节
要求
- Node.js 20 或更高版本(可能在更低版本上运行,但尚未测试)
- Obsidian 笔记库
开发
# 克隆仓库
git clone https://github.com/StevenStavrakis/obsidian-mcp
cd obsidian-mcp
# 安装依赖项
npm install
# 构建
npm run build
然后将以下内容添加到您的 Claude Desktop 配置中:
{
"mcpServers": {
"obsidian": {
"command": "node",
"args": ["dist/index.js"],
" cwd ": "."
}
}
}
可用工具
obsidian-mcp start: 启动 MCP 服务器obsidian-mcp stop: 停止 MCP 服务器obsidian-mcp status: 检查 MCP 服务器状态
📄 许可证
本项目采用 MIT 许可证。
⚠️ 重要提示
此 MCP 具有读写权限(如果您允许)。请在使用 obsidian-mcp 管理笔记之前,备份您的 Obsidian 笔记库。我建议使用 git,但任何备份方法都可以。这些工具已经过测试,但尚未彻底测试,并且此 MCP 正处于积极开发中。
💡 使用建议
- 备份您的 Obsidian 笔记库在使用此工具之前。
- 确保 Node.js 版本符合要求。
Scan to contact