Skip to main content
Glama
MarkusPfundstein

MCP server for Obsidian

Obsidian 的 MCP 服务器

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

成分

工具

服务器实现了多个工具来与 Obsidian 交互:

  • list_files_in_vault:列出 Obsidian 保险库根目录中的所有文件和目录

  • list_files_in_dir:列出特定 Obsidian 目录中的所有文件和目录

  • get_file_contents:返回保险库中单个文件的内容。

  • 搜索:在库中的所有文件中搜索与指定文本查询匹配的文档

  • patch_content:将内容插入到相对于标题、块引用或前置字段的现有注释中。

  • append_content:将内容附加到保险库中的新文件或现有文件。

  • delete_file:从您的保管库中删除文件或目录。

示例提示

最好先指示 Claude 使用 Obsidian。这样它就会一直调用该工具。

使用提示如下:

  • 获取上次架构通话记录的内容并进行总结

  • 搜索所有提及 Azure CosmosDb 的文件,并快速向我解释其提及的上下文

  • 总结上次会议的笔记,并将其添加到新笔记“summary meeting.md”中。添加简介,以便我可以通过电子邮件发送。

Related MCP server: MCP Tools for Obsidian

配置

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>" } } }
  1. 在工作目录中创建一个.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 密钥。

克劳德桌面

在 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

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

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

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/MarkusPfundstein/mcp-obsidian'

If you have feedback or need assistance with the MCP directory API, please join our Discord server