← 返回目录
O

Obsidian Local REST API

社区
为 Obsidian 库提供安全的 REST API 和 MCP 服务器
GitHub 源仓库 ↗
★ 2.9k Stars 分类 · 文件系统 非常热门 源版本 58bc2c443454
64FMRS · C
可靠性
7/20
安全与权限
14/20
维护活跃度
13/20
文档质量
16/20
安装易用性
14/20

一个功能丰富的 MCP 服务器,提供对 Obsidian 笔记的完整本地 API 访问。最适合作希望以编程方式自动化笔记管理和 AI 集成的技术用户。由于基于自签名证书和本地 HTTP 服务器,安全性主要是一个关注点,但就功能而言,尚未见到类似的替代方案。

查看 FMRS 评分方法 →

此 MCP 服务器作为 Obsidian 插件的一部分运行,为您的笔记库提供安全的 REST API。它支持通过 HTTP 进行完整的文件 CRUD 操作、按标题/块/前置元数据精确编辑、全文搜索和结构化搜索,以及执行 Obsidian 命令。MCP 服务器通过流式 HTTP 与授权的 AI 代理连接,使它们能够与您的笔记无缝交互。所有请求均通过 HTTPS(自签名证书)并由 API 密钥保护。

工具能力

vault_list
列出库目录中的文件和子目录
vault_read
读取文件的内容、前置元数据、标签和统计信息
vault_write
创建或覆盖库中的文件
vault_append
将内容追加到库中文件的末尾
vault_patch
修补特定标题、块引用或前置元数据字段
vault_delete
删除库中的文件(默认移入回收站)
vault_move
将库中的文件移动(重命名)到新路径
vault_copy
将库中的文件复制到新路径
vault_get_document_map
列出文件中的标题、块引用和前置元数据字段
active_file_get_path
返回 Obsidian 中当前打开文件的库路径
search_query
使用 JsonLogic 查询对笔记元数据进行搜索
search_simple
使用 Obsidian 内置搜索进行全文搜索
tag_list
列出整个库中的所有标签及其使用次数
command_list
列出所有已注册的 Obsidian 命令
command_execute
按 ID 执行 Obsidian 命令
open_file
在 Obsidian 界面上打开文件

安装接入

在 Obsidian 中安装并启用 'Local REST API' 插件。前往设置 → Local REST API 获取 API 密钥和证书。然后,将 MCP 客户端配置为连接到 https://127.0.0.1:27124/mcp/,并在请求头中提供 API 密钥(Authorization: Bearer <your-api-key>)。对于 Claude Desktop,需使用 mcp-remote 桥接器。

claude_desktop_config.json
{
  "mcpServers": {
    "obsidian": {
      "type": "http",
      "url": "https://127.0.0.1:27124/mcp/",
      "headers": {
        "Authorization": "Bearer <your-api-key>"
      }
    }
  }
}

选型与风险

适合谁

  • 需要在其 Obsidian 笔记库上具有编程控制的用户,以实现自动化和 AI 集成。
  • 构建笔记自动化工作流的开发者和高级用户。
  • 希望 AI 代理直接在其笔记上操作,而无需导出或手动复制的场景。

不适合谁

  • 不熟悉技术设置或无法处理自签名证书的用户。
  • 需要公共访问及其笔记或非本地服务器的场景,因为服务器是为本地使用设计的。
  • 需要与不安全的 HTTP 或更高级的其他 MCP 传输兼容的客户端,因为此服务器仅支持流式 HTTP。

所需权限

  • 对 Obsidian 库中所有文件的完全读写和删除访问权限。
  • 执行任何 Obsidian 命令(相当于使用命令面板)。
  • 访问当前活动文件的信息。
  • 在 Obsidian 的用户界面中打开文件。

风险与副作用

  • 如果 API 密钥被泄露,攻击者可以查看和修改您的所有笔记,甚至执行命令或删除文件。
  • 自签名证书可能导致中间人攻击,如果未正确验证,则存在风险。
  • 运行命令可能导致意外修改,例如删除或覆盖笔记。
  • 监听本地端口的 HTTP 服务可能被其他本地程序利用。

常见排障

  1. 确保证书被信任。在 https://127.0.0.1:27124/ 下载证书并信任它,或使用 HTTP 端点(http://127.0.0.1:27123/mcp/),但必须先在设置中启用。
  2. 验证 API 密钥是否正确,以及 Obsidian 是否正在运行且插件已启用。
  3. 查看 Obsidian 控制台(Ctrl+Shift+I)以查看任何插件错误。

使用场景

自动化笔记管理流程,例如通过脚本创建或更新笔记。
让 AI 助手访问和编辑您的 Obsidian 笔记以进行知识管理。
通过结构化的搜索查询从笔记中提取信息。
通过编程方式执行 Obsidian 命令,例如每日笔记的创建。

支持客户端

Claude Desktop完整支持