Obsidian MCP Server 使用说明

项目简介

Obsidian MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在让 AI 助手(如 Claude)能够安全地访问和操作您的 Obsidian 知识库。通过此服务器,AI 助手可以读取、创建、编辑、移动和删除 Obsidian 笔记,以及管理标签和搜索知识库内容,从而实现更智能化的知识管理和应用。

主要功能点

  • 知识库访问: 允许 AI 助手读取和搜索 Obsidian 知识库中的笔记内容。
  • 笔记管理: 支持 AI 助手创建、编辑、移动和删除 Obsidian 笔记。
  • 标签管理: 使 AI 助手能够添加、移除和重命名 Obsidian 笔记中的标签。
  • 多知识库支持: 可以同时连接和管理多个 Obsidian 知识库。
  • 工具化操作: 提供一系列预定义的工具,例如 'read-note'、'create-note'、'search-vault' 等,供 AI 助手调用执行。
  • 安全访问控制: 通过路径限制,确保 AI 助手只能访问指定的 Obsidian 知识库目录。

安装步骤

  1. 安装 Node.js: 确保您的系统已安装 Node.js 20 或更高版本。您可以从 nodejs.org 下载并安装。

  2. 手动安装 (推荐):

    • 打开 Claude Desktop 的配置文件 'claude_desktop_config.json'。
      • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
      • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
    • 在 'mcpServers' 字段下添加 'obsidian' 服务器配置。
  3. 通过 Smithery 安装 (可选):

    • 如果您熟悉 Smithery,可以使用以下命令进行安装:
      npx -y @smithery/cli install obsidian-mcp --client claude
      注意: 作者声明未测试 Smithery 安装方式,推荐手动安装。

服务器配置

在 'claude_desktop_config.json' 文件中,您需要配置 'obsidian' 服务器的启动命令和参数。以下是配置示例,请根据您的实际情况修改:

{
    "mcpServers": {
        "obsidian": {
            "command": "npx",
            "args": [
                "-y",
                "obsidian-mcp",
                "/path/to/your/vault"  //  请替换为您的 Obsidian 知识库的绝对路径,例如 "/Users/username/Documents/MyVault" (macOS/Linux) 或 "C:\\Users\\username\\Documents\\MyVault" (Windows)
                // 可以添加多个知识库路径,例如:"/path/to/your/vault2"
            ]
        }
    }
}

参数说明:

  • 'command': 启动服务器的命令,这里使用 'npx' 运行 'obsidian-mcp' 包。
  • 'args': 传递给服务器的参数列表。
    • '"-y"': 'npx -y' 参数,自动确认安装 'obsidian-mcp' 包。
    • '"obsidian-mcp"': 要执行的 npm 包名,即 Obsidian MCP Server。
    • '"/path/to/your/vault"': 必填参数,您需要替换为您的 Obsidian 知识库的绝对路径。如果需要连接多个知识库,可以继续在后面添加更多知识库的绝对路径。

配置注意事项:

  • 绝对路径: 知识库路径必须是绝对路径,不能使用相对路径。
  • 知识库有效性: 确保提供的路径是有效的 Obsidian 知识库目录,即该目录下包含 '.obsidian' 文件夹。
  • 重启 Claude: 保存配置文件后,需要重启 Claude Desktop 才能使配置生效。
  • 日志查看: 如果遇到连接问题,可以查看 Claude Desktop 的 MCP 服务器日志文件进行排查。
    • macOS: '~/Library/Logs/Claude/mcp*.log'
    • Windows: '%APPDATA%\Claude\logs\mcp*.log'

基本使用方法

  1. 启动服务器: 配置完成后,重启 Claude Desktop,如果配置正确,您应该能在 Claude 界面看到锤子图标,表示 MCP 服务器已连接。
  2. 与 AI 助手交互: 您现在可以指示 Claude 等 AI 助手使用 Obsidian MCP Server 提供的工具来操作您的 Obsidian 知识库。例如,您可以要求 Claude "在我的 Obsidian 知识库中创建一个名为 '会议记录' 的笔记,内容是 ... ",Claude 将会调用 'create-note' 工具来完成操作。
  3. 使用 Prompt 发现知识库: 您可以使用 'list-vaults' Prompt 让 AI 助手列出可用的 Obsidian 知识库名称,以便在后续的工具调用中使用正确的知识库名称。

安全警告:

请务必备份您的 Obsidian 知识库,因为此 MCP 服务器具有读写权限。虽然工具经过测试,但仍可能存在潜在风险。

信息

分类

生产力应用