Obsidian 的 MCP 服务器

用于通过 Local REST API 社区插件与 Obsidian 交互的 MCP 服务器。

<a href="https://glama.ai/mcp/servers/3wko1bhuek"><img width="380" height="200" src="https://glama.ai/mcp/servers/3wko1bhuek/badge" alt="server for Obsidian MCP server" /></a>

组件

工具

该服务器实现了多个与 Obsidian 交互的工具：

• list_files_in_vault: 列出 Obsidian vault 根目录中的所有文件和目录
• list_files_in_dir: 列出特定 Obsidian 目录中的所有文件和目录
• get_file_contents: 返回 vault 中单个文件的内容。
• search: 在 vault 的所有文件中搜索与指定文本查询匹配的文档
• patch_content: 将内容插入到现有笔记中，相对于标题、块引用或 frontmatter 字段。
• append_content: 将内容附加到 vault 中的新文件或现有文件。
• delete_file: 从 vault 中删除文件或目录。

示例提示

最好首先指示 Claude 使用 Obsidian。 然后它将始终调用该工具。

使用如下提示：

• 获取上次架构会议记录的内容并进行总结
• 搜索所有提到 Azure CosmosDb 的文件，并向我快速解释其中提到的上下文
• 总结上次的会议记录，并将其放入一个新的笔记 'summary meeting.md' 中。 添加一个介绍，以便我可以通过电子邮件发送它。

配置

Obsidian REST API 密钥

有两种方法可以使用 Obsidian REST API 密钥配置环境。

1. 添加到服务器配置（首选）

{
  "mcp-obsidian": {
    "command": "uvx",
    "args": [
      "mcp-obsidian"
    ],
    "env": {
      "OBSIDIAN_API_KEY":"<your_api_key_here>"
    }
  }
}

2. 在工作目录中创建一个 .env 文件，其中包含以下必需变量：

OBSIDIAN_API_KEY=your_api_key_here

注意：您可以在 Obsidian 插件配置中找到密钥。

快速开始

安装

Obsidian REST API

您需要运行 Obsidian REST API 社区插件：https://github.com/coddingtonbear/obsidian-local-rest-api

在设置中安装并启用它，并复制 API 密钥。

Claude Desktop

在 MacOS 上：~/Library/Application\ Support/Claude/claude_desktop_config.json

在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

<details> <summary>开发/未发布的服务器配置</summary>

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ]
    }
  }
}

</details>

<details> <summary>已发布的服务器配置</summary>

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY" : "<YOUR_OBSIDIAN_API_KEY>"
      }
    }
  }
}

</details>

开发

构建

要准备用于分发的软件包：

1. 同步依赖项并更新 lockfile：

uv sync

调试

由于 MCP 服务器通过 stdio 运行，因此调试可能具有挑战性。 为了获得最佳调试体验，我们强烈建议使用 MCP Inspector。

您可以使用 npm 通过以下命令启动 MCP Inspector：

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian

启动后，Inspector 将显示一个 URL，您可以在浏览器中访问该 URL 以开始调试。

您还可以使用以下命令查看服务器日志：

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log