Obsidian 的 MCP 服务器

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

组件

工具

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

• list_files_in_vault：列出 vault 根目录中的所有文件和目录
• list_files_in_dir：列出特定 Obsidian 目录中的所有文件和目录
• get_file_contents：返回 vault 中单个文件的内容
• search：在 vault 中的所有文件中搜索与指定文本查询匹配的文档
• patch_content：相对于标题、块引用或前端字段插入内容到现有笔记中
• append_content：追加内容到新文件或现有文件中
• 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>",
      "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\ 支持/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>"
      }
    }
  }
}
</details>

## 开发

### 构建

要准备分发包：

1. 同步依赖项并更新锁定文件：
```bash
uv sync

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

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