Obsidian AI集成服务

通过MCP服务器将Claude AI无缝集成到Obsidian中,实现AI驱动的笔记管理和知识工作流增强。

  • by Trao95
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 Trao95/Obsidian-MCP-Server

使用说明

黑曜石MCP服务器

将Claude AI无缝集成到您的黑曜石金库中!本指南为Windows 11上的模型上下文协议(MCP)服务器提供了一个简单的设置,使Claude能够直接协助您在Obsidian中进行头脑风暴、记笔记和知识管理。

黑曜石人工智能集成:为克劳德桌面设置MCP服务器

本指南提供了设置 黑曜石模型上下文协议(MCP)服务器 在Windows 11上。该服务器充当桥梁,允许外部AI应用程序,如 克劳德桌面 安全地读写您的黑曜石保险库,直接用您的笔记解锁强大的人工智能驱动的工作流程。


目录


为什么要使用黑曜石MCP服务器?

模型上下文协议(MCP)服务器使AI模型能够:

  • 阅读您的笔记: 访问vault的内容以进行摘要、深入分析和上下文理解。
  • 创建和修改注释: 根据人工智能提示生成新想法、起草内容或更新现有文件。
  • 搜索您的保险库: 在您的知识库中进行全面搜索,为AI任务找到相关信息,使您的知识真正智能化。

当您希望像Claude Desktop这样的独立AI应用程序直接与您的知识库协同工作时,这种集成特别有用,通常比单独使用Obsidian插件提供更深入、更无缝的交互。


先决条件

在开始之前,请确保您拥有以下内容:

  • 黑曜石安装: 您希望与AI集成的活动黑曜石金库。
  • Node.js(版本20或更高): MCP服务器在Node.js上运行。
    • 检查您的版本: 打开PowerShell并运行: node -v
    • 如果您没有Node.js或它是旧版本,请从以下网址下载并安装最新的LTS(长期支持)版本 nodejs.org.
  • 克劳德桌面: 您将要连接的AI应用程序。

分步安装指南(Windows 11)

请仔细遵循以下说明,将您的Obsidian MCP服务器与Claude Desktop集成。

第一阶段:准备你的黑曜石储藏室

此阶段设置了一个关键的黑曜石社区插件,可以安全地从外部访问您的保险库。

  1. 打开你的黑曜石保险库: 启动Obsidian并打开您希望AI与之交互的特定保险库。
  2. 转到设置: 点击 齿轮图标 黑曜石窗口左下角的(设置)。
  3. 导航到社区插件: 在设置侧栏中,单击 社区插件.
  4. 关闭限制模式: 如果启用了“限制模式”,请切换它 关。如果出现提示,请确认该操作。
  5. 浏览插件: 点击 浏览 “社区插件”旁边的按钮
  6. 搜索“本地REST API”: 在搜索栏中,键入 Local REST API.
  7. 安装插件: 查找“本地REST API”插件(由开发 pjeby)然后单击 安装.
  8. 启用插件: 安装后,单击 启用 按钮。
  9. 配置本地REST API并生成API密钥:
    • 在社区插件列表中,找到“本地REST API”
    • 点击 齿轮图标 在其旁边(或“选项”按钮)访问其设置。
    • 找到该部分 生成新的API密钥 然后单击按钮。
    • 至关重要的是,立即复制此生成的API密钥。 此密钥高度敏感,可以访问您的保管库。将其视为密码;不要公开分享。你将在下一阶段需要它。

阶段2:配置Claude Desktop以启动MCP服务器

在此阶段,您将配置Claude Desktop,以便在Claude Desktop启动时自动启动和管理黑曜石MCP服务器。

  1. 完全关闭克劳德桌面: 确保应用程序完全关闭,而不仅仅是最小化到系统托盘。如有必要,使用任务管理器(Ctrl+Shift+Esc),在“应用程序”或“后台进程”部分找到“Claude”,右键单击,然后选择“结束任务”

  2. 找到Claude Desktop的配置文件:

    • 打开文件资源管理器。
    • 在地址栏中,键入: %APPDATA%\Claude\ 并按 进入.
    • 您应该找到一个名为的文件 claude_desktop_config.json 直接在此文件夹中。如果它不存在,请使用此确切名称创建一个新的纯文本文件。
  3. 编辑配置文件:

    • 打开 claude_desktop_config.json 使用纯文本编辑器(例如记事本、VS Code、Notepad++)。
    • 重要提示: 如果你有一个现有的配置(例如,对于Blender MCP服务器),你将添加黑曜石条目 旁边 用逗号分隔。
    • 添加或修改 mcpServers 部分包括您的Obsidian MCP服务器配置:
    {
      "mcpServers": {
        "obsidian": { // You can name this anything, "obsidian" is descriptive.
          "command": "npx",
          "args": ["-y", "obsidian-mcp", "YOUR_OBSIDIAN_VAULT_PATH_HERE"],
          "env": {
            "OBSIDIAN_API_KEY": "YOUR_ACTUAL_OBSIDIAN_API_KEY_HERE"
          }
        }
        // If you have other servers (like Blender), they would be listed here,
        // separated by a comma from the "obsidian" entry, like this:
        // "anotherServerName": { ... },
        // "obsidian": { ... }
      }
    }
    
    • 上述配置要点:
      • 替换 YOUR_OBSIDIAN_VAULT_PATH_HERE 随着 系统上黑曜石保管库文件夹的精确、完整、绝对路径。
        • Windows示例: "C:/Users/YourUser/Documents/MyVault" (使用正斜杠,通常在JSON中推荐)
        • 或者(Windows): "C:\\Users\\YourUser\\Documents\\MyVault" (使用双反斜杠)
      • 替换 YOUR_ACTUAL_OBSIDIAN_API_KEY_HERE 随着 精确的API密钥 您从第1阶段第9步复制。这是一长串字符。
    • 保存 claude_desktop_config.json 文件。
  4. 验证JSON语法:

    • 复制 全部内容 你的修改 claude_desktop_config.json 文件。
    • 转到在线JSON验证器,如 jsonlint.com.
    • 将JSON粘贴到验证器中,然后单击“验证JSON” 它 必须 说“有效的JSON” 如果它显示任何错误(例如,“缺少逗号”、“字符串错误”),请在您的 claude_desktop_config.json 文件并再次保存。
  5. 重新启动克劳德桌面: 启动克劳德桌面。给它一两分钟的时间,让它完全加载并尝试启动MCP服务器。

一旦Claude Desktop启动,它现在应该能够与您的黑曜石保险库通信!在Claude Desktop的用户界面中寻找它识别黑曜石服务器的迹象。


常见问题排查

以下是安装过程中遇到的常见问题的解决方案:

  • 不 mcp-debug.log 文件已生成:

    • 这表明Claude Desktop甚至没有尝试启动MCP服务器或处理其输出。
    • 验证 claude_desktop_config.json 地点: 确保文件 精确地 命名 claude_desktop_config.json 并且位于 直接 在……里面 %APPDATA%\Claude\。没有子文件夹。
    • 验证 claude_desktop_config.json 语法: 一个语法错误(例如,缺少逗号、大括号或引号)将阻止Claude读取整个文件。使用 jsonlint.com 以验证整个文件。
    • 执行克劳德桌面的硬重启: 使用任务管理器(Ctrl+Shift+Esc)为所有Claude进程“结束任务”,然后重新启动。
  • claude_desktop_config.json 语法错误:

    • 使用JSON验证器: 始终复制您的全部 claude_desktop_config.json 内容并粘贴到 jsonlint.com 每次改变之后。它将精确定位语法错误。

    • 缺少逗号: 如果您在中有多个服务器 mcpServers (例如。, blender 和 obsidian),每个条目(最后一个除外)后面都必须跟一个逗号。

      "server1": { ... },  <-- COMMA HERE
      "server2": { ... }
      
  • 仅显示现有的MCP服务器(例如Blender):

    • 当您覆盖了现有配置或引入了阻止解析新条目的语法错误时,就会发生这种情况。
    • 确保正确的JSON结构: 添加新服务器时,请确保它是 mcpServers 对象,与前面的条目用逗号分隔。请参阅中的示例 第2阶段,第3步.
  • API密钥或Vault路径错误:

    • 即使 mcp-debug.log 如果生成,这些错误将经常出现在其中。
    • API密钥: 仔细检查 OBSIDIAN_API_KEY 在你的 claude_desktop_config.json 与Obsidian的“本地REST API”插件设置中生成的密钥完全匹配。确保在复制粘贴过程中没有多余的空格或遗漏的字符。
    • 保险库路径: 验证路径 YOUR_OBSIDIAN_VAULT_PATH_HERE 是 精确、绝对的路径 到您的黑曜石保管库文件夹。确认正确的斜线用法: C:/path/to/vault (正斜杠)或 C:\\path\\to\\vault JSON字符串中的(双反斜杠)。
  • 日志中的服务器错误(例如,“地址已在使用中”):

    • 如果 mcp-debug.log 显示MCP服务器尝试启动,但失败,端口上出现“地址已在使用中”等错误 27123:
    • 另一个应用程序(或MCP服务器的前一个实例)已经在使用该端口。
    • 解决方案: 您可以尝试配置 obsidian-mcp 服务器使用其他端口。
      • 在……里面 claude_desktop_config.json,修改 args 数组用于 obsidian 服务器:
        "args": ["-y", "obsidian-mcp", "YOUR_OBSIDIAN_VAULT_PATH_HERE", "--port", "27124"],
        
      • 然后,执行Claude Desktop的硬重启。
  • 一般连接问题/Claude未获取配置:

    • 如果其他一切看起来都正确,但克劳德仍然无法识别服务器:
    • 硬重启克劳德桌面: 正如在故障排除过程中发现的那样,有时标准的重启是不够的。使用任务管理器(Ctrl+Shift+Esc)确保在重新启动之前结束所有“Claude”进程。
    • 重新安装克劳德桌面(最后手段): 如果其他方法都失败了,请考虑卸载并重新安装Claude Desktop。

贡献

如果您遇到新问题、有改进或找到更清晰的方法来解释这些步骤,请随时打开问题或提交拉取请求!你的贡献有助于他人。


附加故障排除/重要注意事项

有时,Claude无法连接到服务器,如果发生此问题,请在Taskmanager中结束Claude的所有任务并重新打开它,它就会工作。


许可证

本指南在 MIT许可证.