面向 Obsidian 的 MCP 服务器

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

组件

工具

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

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

示例提示

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

使用类似这样的提示：

• 获取上次架构会议笔记的内容并总结
• 搜索所有提及 Azure CosmosDb 的文件并快速解释其提及上下文
• 总结上次会议记录并放入新笔记'summary meeting.md'。添加引言以便我可以通过电子邮件发送

配置

Obsidian REST API 密钥

有两种方式配置环境变量 Obsidian REST API Key：

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

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

2. 在工作目录创建包含以下必需变量的 .env 文件：

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host

注意：您可以在 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

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

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

开发

构建

准备分发包：

1. 同步依赖并更新锁文件：

uv sync

调试

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

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

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

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

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

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