← 返回目录
O

Obsidian Local REST API

社区
为 Obsidian 库提供安全的 REST API 和 MCP 服务器
分类
文件系统 第 5 / 24
Stars
★ 3.0k 非常热门
传输方式
Streamable HTTP
运行环境
Node.js
凭据
需要 API Key / 凭据
许可证
MIT
最近提交
工具数
16
64FMRS · C

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

最强项 · 文档质量 16/20 最弱项 · 可靠性 7/20

可靠性
7/20
安全与权限
14/20
维护活跃度
13/20
文档质量
16/20
安装易用性
14/20
查看各项评分依据
可靠性 7/20
提供的材料仅含 README 与仓库元数据:无 manifest、无源码、无 CI 工作流、无已提交测试。README 声称内置 15 个 MCP 工具并通过 Streamable HTTP 提供 /mcp/ 端点,工具清单与 REST 能力一致,甚至描述了错误形态行为(如弃用响应头、400/422 拒绝冲突目标),正常路径看起来连贯可行。但没有任何可验证的执行证据支撑 MCP 初始化、工具列表握手或工具实际行为;README 自身也显示客户端侧摩擦(Claude Desktop 需 mcp-remote 桥接、证书信任因客户端而异)。静态校准规定无执行证据时可靠性上限为 12,因缺少测试与 CI 证据并遵循保守与向下取整原则,定为 7。
安全与权限 14/20
未触发红线:存在 API Key Bearer 认证、服务绑定 127.0.0.1(本地回环)、安装示例一律使用占位符而非真实令牌;明文 HTTP 端点为可选且 README 明确警告其不安全;删除工具默认移入回收站,缓解了破坏性副作用。扣分项:README 未展示危险操作的逐次确认流程、没有可见的安全策略或漏洞披露渠道、扩展 API 允许其他插件注册路由从而扩大信任边界、自签名证书与 HTTP 回退方案虽已披露但本身较弱。权限与数据边界大体清晰,故高于 10 分,但离 20 分的‘最小权限+明确确认+数据流完全披露’仍有差距,定为 14。
维护活跃度 13/20
证据包括:MIT 许可证明确、仓库未归档、开放 issue 极少(2 个)、README 展示活跃版本管理(针对 6.0 的弃用时间表)、npm 类型化扩展 API(obsidian-local-rest-api 包)、贡献指南与已知扩展生态。扣分项:所供材料中看不到提交历史、发布节奏、依赖更新机制或安全响应渠道,无法验证维护活跃度的持续性。因此给予中上但非满分,定为 13。
文档质量 16/20
README 质量高且分层:REST 与四类 MCP 客户端(Claude Code、Claude Desktop、Cursor、其他)的快速上手、完整端点表、MCP 工具与资源表、认证与证书说明、弃用提示与迁移说明,并链接交互式 API 文档与 Wiki。扣分项:README 未提供 MCP 工具的参数字段级 schema(仅名称与单行描述)、故障排查内容较零散(多为证书信任警告)、未显式披露资源/性能限制。不足以给满分,定为 16。
安装易用性 14/20
主流路径步骤清晰且少:安装并启用 Obsidian 插件、从设置页复制 API Key、粘贴现成的客户端配置(Claude Code/Cursor 给出完整 JSON,Claude Desktop 给出 mcp-remote 命令);证书下载与信任方式、HTTP 回退选项均有说明,平台路径(macOS/Windows)也列出。扣分项:Claude Desktop 依赖 Node.js 与 mcp-remote 桥接、自签名证书信任因客户端而异带来额外摩擦;且无 CI/测试证据验证这些配置真实可用,静态校准规定无执行证据时 setup 上限为 15,定为 14。

静态评测 · 未实际运行收录于 2026-08-07

查看 FMRS 评分方法 →

选型与风险

能访问什么读取本地文件写入 / 删除本地文件

适合谁

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

不适合谁

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

所需权限

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

风险与副作用

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

安装接入

准备工作

运行环境:Node.js

在 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>"
      }
    }
  }
}

以 Claude Desktop 为例。其他客户端的配置文件位置或字段可能不同(如 VS Code 使用 servers 字段),可用下方配置生成器转换。

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

写入项目的 .vscode/mcp.json(VS Code 使用 servers 字段)。

Terminal
claude mcp add --transport http obsidian https://127.0.0.1:27124/mcp/ --header 'Authorization: Bearer <your-api-key>'

在终端运行;先把 <…> 占位符换成你自己的值。

验证是否装好

在客户端连接 https://127.0.0.1:27124/mcp/ 后,工具列表中应出现 vault_list 等工具;调用 vault_list 即可验证认证和连接是否正常。

常见排障

  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 仓库根目录下的文件
  • 在日记笔记的“Log”标题下追加一条内容“完成了 API 文档整理”
  • 用简单全文搜索找一下包含“季度总结”的笔记
  • 执行 Obsidian 命令并打开今天的每日笔记

工具能力 16

vault_list 只读
列出库目录中的文件和子目录
vault_read 只读
读取文件的内容、前置元数据、标签和统计信息
vault_write 写入
创建或覆盖库中的文件
vault_append 写入
将内容追加到库中文件的末尾
vault_patch 写入
修补特定标题、块引用或前置元数据字段
vault_delete 破坏性
删除库中的文件(默认移入回收站)
vault_move 写入
将库中的文件移动(重命名)到新路径
vault_copy 写入
将库中的文件复制到新路径
展开其余 8 个工具
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 界面上打开文件

使用场景

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

支持客户端

Claude Desktop

依据项目文档列出,未经本站实测。

详细介绍

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

同类可选方案

源版本 532af3565925 数据同步于 2026-10-13 查看 FMRS 评分方法