MCP服务器用于Obsidian

与Obsidian通过本地REST API社区插件进行交互的MCP服务器。

<a href="https://glama.ai/mcp/servers/3wko1bhuek"><img width="380" height="200" src="https://gips1.baidu.com/it/u=881457581,912621803&fm=3081&app=3081&f=PNG?w=760&h=400" alt="用于Obsidian的MCP服务器" /></a>

组件

工具

该服务器实现了多个工具来与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": "<your_api_key_here>",
      "OBSIDIAN_HOST": "<your_obsidian_host>",
      "OBSIDIAN_PORT": "<your_obsidian_port>"
    }
  }
}

有时Claude会遇到检测uv / uvx位置的问题。你可以使用which uvx找到并粘贴上述配置中的完整路径。

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

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host
OBSIDIAN_PORT=your_obsidian_port

注意：

• 你可以在Obsidian插件配置中找到API密钥。
• 如果未指定，默认端口是27124。
• 如果未指定，默认主机是127.0.0.1。

快速开始

安装

Obsidian REST API

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

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

Claude桌面

在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"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "<your_api_key_here>",
        "OBSIDIAN_HOST": "<your_obsidian_host>",
        "OBSIDIAN_PORT": "<your_obsidian_port>"
      }
    }
  }
}

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

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

</details>

开发

构建

为了准备分发的包：

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

uv sync

调试

由于MCP服务器通过标准I/O运行，调试可能会很困难。为了获得最佳的调试体验，我们强烈建议使用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