Obsidian笔记管理服务

一个集成Obsidian笔记与Claude桌面的服务,允许通过自然对话直接读取、写入、搜索和管理Obsidian笔记。

  • by administrativetrick
  • JavaScript
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 administrativetrick/obsidian-mcp

使用说明

Claude桌面版黑曜石MCP服务器

一个模型上下文协议(MCP)服务器,将您的黑曜石保管库与Claude Desktop集成在一起,允许Claude通过自然对话直接读取、写入、搜索和管理您的黑色素笔记。

特性

  • 阅读笔记:阅读你黑曜石金库里的任何笔记
  • 写笔记:创建新笔记或覆盖现有笔记
  • 附加到注释中:向现有笔记添加内容
  • 搜索笔记:按文件名或内容搜索vault
  • 列出注释:获取保管库中所有笔记的完整列表
  • 删除笔记:从保管库中删除笔记
  • 新建文件夹:使用新文件夹组织保管库

先决条件

  • Node.js(v18或更高版本)
  • Claude桌面应用程序
  • 黑曜石拱顶

安装

步骤1:安装MCP服务器

  1. 打开终端/命令提示符

  2. 导航到 obsidian-mcp 文件夹:

    cd path/to/obsidian-mcp
    
  3. 安装依赖项:

    npm install
    
  4. 使脚本可执行(仅限Mac/Linux):

    chmod +x index.js
    

步骤2:配置Claude桌面

您需要编辑Claude Desktop的配置文件以添加Obsidian MCP服务器。

在macOS上:

  1. 打开配置文件:
    code ~/Library/Application\ Support/Claude/claude_desktop_config.json
    
    (或使用任何文本编辑器代替 code)

在Windows上:

  1. 在以下位置打开配置文件:
    %APPDATA%\Claude\claude_desktop_config.json
    

配置:

将以下内容添加到您的 claude_desktop_config.json 文件:

{
  "mcpServers": {
    "obsidian": {
      "command": "node",
      "args": [
        "/FULL/PATH/TO/obsidian-mcp/index.js"
      ],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/FULL/PATH/TO/YOUR/OBSIDIAN/VAULT"
      }
    }
  }
}

重要:用实际路径替换路径:

  • 替换 /FULL/PATH/TO/obsidian-mcp/index.js 与完整的路径 index.js 文件
  • 替换 /FULL/PATH/TO/YOUR/OBSIDIAN/VAULT 包含黑曜石保管库文件夹的完整路径

macOS示例:

{
  "mcpServers": {
    "obsidian": {
      "command": "node",
      "args": [
        "/Users/yourname/obsidian-mcp/index.js"
      ],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/Users/yourname/Documents/MyObsidianVault"
      }
    }
  }
}

Windows示例:

{
  "mcpServers": {
    "obsidian": {
      "command": "node",
      "args": [
        "C:\\Users\\YourName\\obsidian-mcp\\index.js"
      ],
      "env": {
        "OBSIDIAN_VAULT_PATH": "C:\\Users\\YourName\\Documents\\MyObsidianVault"
      }
    }
  }
}

步骤3:重新启动克劳德桌面

保存配置文件后,完全退出并重新启动Claude Desktop以使更改生效。

用法

安装和配置后,您可以通过Claude与黑曜石保险库进行交互。以下是一些示例提示:

读书笔记

  • “阅读我在《每日笔记》/2024-11-26.md上的笔记”
  • “显示Projects/MyProject.md的内容”

创建/编写笔记

  • “创建一个名为'Meeting Notes.md'的新笔记,内容如下:[您的内容]”
  • “在daily Notes/2024-11-26.md中写日记条目”

搜索

  • “在我的黑曜石金库中搜索有关‘机器学习’的笔记”
  • “查找所有提及“项目截止日期”的注释”

上市注意事项

  • “列出我黑曜石金库中的所有笔记”
  • “显示我的所有笔记”

附加内容

  • “将这些想法添加到我的ideas.md文件中:[您的内容]”
  • “将此任务添加到我的Todo.md笔记中”

创建文件夹

  • “在我的保管库中创建一个名为“研究论文”的新文件夹”
  • “在Projects/2024/Q4中创建一个文件夹”

删除笔记

  • “删除Archive/old draft.md中的注释”
  • “删除临时/划痕.md”

故障排除

克劳德不认识黑曜石工具

  1. 确保您已完全退出并重新启动Claude Desktop
  2. 检查你的 claude_desktop_config.json 文件是有效的JSON(没有尾随逗号,引号正确)
  3. 验证配置文件中的路径是否正确,并使用完整/绝对路径
  4. 检查Claude Desktop日志是否有错误:
    • macOS: ~/Library/Logs/Claude/mcp*.log
    • 窗户: %APPDATA%\Claude\logs\mcp*.log

权限错误

确保克劳德有权访问您的黑曜石保管库文件夹。在macOS上,您可能需要在“系统偏好设置”>“安全与隐私”中授予Claude Desktop的“全磁盘访问权限”。

路径问题

在配置文件中始终使用完整/绝对路径,而不是像这样的相对路径 ~/ 或 ./.

安全说明

此扩展程序为Claude提供了对黑曜石保险库的完全读/写访问权限。只有当你对克劳德能够阅读和修改你的笔记感到满意时,才使用它。服务器包括安全检查,以防止访问vault目录外的文件。

支持

如果您遇到问题:

  1. 检查Claude Desktop日志中的错误消息
  2. 验证你的Node.js版本是否为18或更高: node --version
  3. 确保配置中的所有路径都是正确和绝对的
  4. 尝试手动运行服务器,查看是否有任何错误:
    OBSIDIAN_VAULT_PATH="/path/to/vault" node /path/to/index.js
    

贡献

欢迎投稿!请看 贡献.md 作为指导方针。

更新日志

看 更改日志.md 查看此项目的更改历史。

致谢

相关项目

许可证

麻省理工学院-参见 许可证 了解详情。