Obsidian的MCP服务器

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

组件

工具

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

• list_files_in_vault：列出你的Obsidian知识库根目录下的所有文件和文件夹
• list_files_in_dir：列出特定Obsidian文件夹中的所有文件和文件夹
• get_file_contents：返回你知识库中单个文件的内容
• search：在整个知识库的所有文件中搜索包含指定文本的文档
• patch_content：相对于标题、块引用或前置字段，在现有笔记中插入内容
• append_content：向知识库中的新文件或现有文件追加内容
• delete_file：从你的知识库中删除文件或文件夹

示例提示

最好先指示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": "<你的_api_密钥>",
      "OBSIDIAN_HOST": "<你的_obsidian主机>"
    }
  }
}

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

OBSIDIAN_API_KEY=你的_api_密钥
OBSIDIAN_HOST=你的_obsidian主机

注意：你可以在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",
        "<目录>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY" : "<你的_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，你可以在浏览器中访问该URL开始调试。

你也可以使用以下命令查看服务器日志：

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