mcpField
M
mcp-obsidian-cli

mcp-obsidian-cli

本地服务
github.com/stonematt生产力28 周前更新

关于 mcp-obsidian-cli

mcp-obsidian-cli 将 Claude Desktop 对话与 Obsidian 知识库连接起来,用于保存和检索笔记。它通过 MCP 暴露 Obsidian CLI 命令,既提供常用任务的专用工具,也支持通用命令透传。

主要功能

  1. 01将对话保存为知识库笔记
  2. 02读取笔记和每日笔记
  3. 03全文搜索与反向链接
  4. 04使用 Templater 模板创建笔记
  5. 05访问 80 多个 CLI 命令

适用场景

  1. 01将有价值的 Claude Desktop 对话保存到知识库
  2. 02在聊天中检索知识库上下文
  3. 03向每日笔记追加信息

MCP 相关

MCP 服务将 Obsidian CLI 命令作为工具提供,包括通用透传工具和常见操作的专用工具。需要 Obsidian 正在运行且已启用其 CLI。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"stonematt-mcp-obsidian-cli": {
"command": "npx",
"args": [
"-y",
"mcp-obsidian-cli"
],
"env": {
"OBSIDIAN_VAULT": "<OBSIDIAN_VAULT>",
"OBSIDIAN_CLI_PATH": "<OBSIDIAN_CLI_PATH>",
"OBSIDIAN_TIMEOUT_MS": "<OBSIDIAN_TIMEOUT_MS>"
}
}
}
}
启动命令npx -y mcp-obsidian-cli
需要配置的环境变量
OBSIDIAN_VAULTTarget vault name. If unset or unknown, the server prompts the caller on first tool use, listing the vaults Obsidian knows about.
OBSIDIAN_CLI_PATHPath to the obsidian-cli binary. Auto-discovered on macOS; set explicitly on Linux/Windows or if the binary is non-standard.
OBSIDIAN_TIMEOUT_MSPer-command timeout in milliseconds.

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npmmcp-obsidian-cli2.1.0

工具

23

收录的工具列表 · 更新于 2 周前

参数类型必填说明
commandstring是CLI 命令及参数

详细介绍

mcp-obsidian-cli

Obsidian CLI npm version npm downloads MCP Registry Node License: MIT

你的思考始于 Claude Desktop,而非 Obsidian。你进行研究、起草内容、与模型辩论;当觉得某些内容值得保存时,只需说“把这个保存到我的知识库”。它会被放到正确的位置:使用你的模板、属性和当天的每日笔记,并接入你的链接图谱。无需切换标签页,也无需复制粘贴。

要安装吗? 请从安装开始。在 Claude Code 中运行一条提示词即可完成全部设置。

将 Claude Desktop 对话保存到 Obsidian 知识库,然后在聊天中搜索知识库

主要包含两部分:

  • 捕获 — 将对话转化为正式笔记,并归档到合适的位置。
  • 增强 — 将知识库中已有的内容(反向链接、全文搜索)引入聊天,以便参考或更新笔记。

需要 Obsidian 正在运行。它可以最小化,因此你无需切换到它。

如果你在 Claude Code 中使用,原生的 obsidian-cli 技能更适合:直接使用 CLI,无需 MCP 层。安装需单独进行。请在 Claude Code 中运行下方的提示词。

安装

在 Claude Code 中运行下方的提示词。它会检查 Node、启用 Obsidian CLI、写入 Claude Desktop 配置,并验证连接。只有在该方法失败时才手动编辑配置。

Fetch https://raw.githubusercontent.com/stonematt/mcp-obsidian-cli/master/docs/INSTALL.md
and follow it end to end to install the mcp-obsidian-cli MCP server for my Claude Desktop.
Ask me for my Obsidian vault name and folder path, then handle everything else — check Node,
enable the Obsidian CLI, edit my Claude Desktop config, and verify it works.

完整的操作指南(包括故障处理):docs/INSTALL.md。

直接运行服务。 这会在终端中启动服务,不会安装任何内容:

npx mcp-obsidian-cli

要求

安装提示词会逐项检查以下要求。此处列出供参考:

  • Obsidian 正在运行,且已启用命令行界面(设置 → 通用 → 高级 → 命令行界面)。CLI 内置于 Obsidian,无需额外安装。
  • 可以访问 obsidian-cli。macOS 会在 Obsidian 应用程序包中自动检测,因此无需配置。Linux 和 Windows 不支持自动检测:请自行将 OBSIDIAN_CLI_PATH 指向该二进制文件。
  • Node.js >= 18

工作原理

该服务将 Obsidian CLI 命令作为 MCP 工具提供。一个通用直通工具可处理完整的 CLI 命令集(80 多个命令),此外还提供用于常见操作的类型化便捷工具:

工具描述
obsidian通用直通工具 — 运行任意 CLI 命令(内置意图→动词速查表、调用前清单验证和重新加载检测)
obsidian_help基于清单的帮助 — 按类别列出动词,或查询单个动词/文档主题
obsidian_daily_read读取今天的每日笔记
obsidian_daily_append向每日笔记追加内容
obsidian_read按名称或路径读取笔记
obsidian_search带上下文的全文搜索
obsidian_tags列出标签及其数量
obsidian_tasks查询任务(每日、待办、已完成)
obsidian_properties读取 frontmatter 属性
obsidian_create创建新的普通笔记(不展开 Templater 内容)
obsidian_create_from_template使用 Templater 模板创建笔记(展开 <% ... %> 占位符)
obsidian_property_set设置 frontmatter 属性
obsidian_backlinks列出指向某篇笔记的反向链接
obsidian_files列出知识库文件
obsidian_recents最近打开的文件

通用 obsidian 工具意味着 MCP 服务永远不会落后于 CLI — 新的 CLI 命令无需更新服务即可立即使用。

功能

它会与正在运行的 Obsidian 实例交互,因此能够按照 Obsidian 的方式访问你的知识库:

  • 反向链接和全文搜索:基于已解析的链接图谱和搜索索引(增强部分)。
  • 创建或更新笔记时支持 Templater 模板和类型化的 frontmatter 属性。
  • 每日笔记、任务查询和标签计数。
  • 通过通用直通工具支持 80 多个命令。无需 API 密钥,也无需 REST 插件,只需官方 Obsidian CLI。
手动配置(如果你不使用 Claude Code)

自动安装程序应使用 安装 下的提示词,其中会处理知识库名称、CLI 路径和验证。此处的配置块是手动编辑时的备用方案。

添加到 ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "mcp-obsidian-cli"],
      "env": {
        "OBSIDIAN_VAULT": "my-vault"
      }
    }
  }
}

环境变量

变量默认值描述
OBSIDIAN_VAULT(none)按名称指定目标知识库
OBSIDIAN_CLI_PATHobsidian-cliCLI 二进制文件的路径
OBSIDIAN_TIMEOUT_MS15000命令超时时间
XDG_CONFIG_HOME~/.config配置文件的基础路径

配置文件

该服务可以从 YAML 配置文件读取设置:

  • 默认:~/.config/mcp-obsidian-cli/config.yaml
  • 使用 XDG_CONFIG_HOME 时:$XDG_CONFIG_HOME/mcp-obsidian-cli/config.yaml

配置文件格式:

vault: "my-vault"
cliPath: "obsidian-cli"
timeoutMs: 15000

配置优先级:环境变量 > 配置文件 > 硬编码默认值

问题/请求

提交问题:https://github.com/stonematt/mcp-obsidian-cli/issues/new/choose。问题模板会询问版本、MCP 客户端、工具调用和响应 — 填写快捷,处理迅速。

许可证

MIT

ko-fi

由 @stonematt 维护 基于 MIT 许可证授权

商标声明:“Obsidian”是 Obsidian Publishing, Inc. 的商标。本项目与 Obsidian Publishing 无关联,也未获其认可。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。