尧图建网站 尧图建网站 YAOTU WEB BUILD 免费咨询
ARTICLE DETAIL

资讯详情

深耕网站建设与建站编程的一线实战洞察。

obsidian-mcp MCP 服务说明文档

obsidian-mcp MCP 服务说明文档 1. 服务概述一句话简介为Claude和任何MCP客户端提供对Obsidian vault的真实代理访问支持图遍历、Dataview查询、每日笔记感知等功能服务名称obsidian-mcp版本号最新版本通过npm发布开发者/提供方yanxue06协议类型MCP (Model Context Protocol)2. 核心功能该MCP服务提供15个工具将Obsidian vault视为知识图谱而非简单的文件系统2.1 读取功能get_note获取笔记内容及图上下文反向链接、前向链接、标签、前置元数据get_active_note获取当前在Obsidian中聚焦的笔记get_daily_note获取今日的每日/每周/每月/每季/每年笔记list_vault列出所有文件或指定文件夹中的文件默认仅显示markdown文件2.2 搜索与图功能search_vault全文搜索或#标签搜索返回片段query_dataview运行Dataview DQL查询需要Dataview插件traverse_graph从笔记出发进行N跳遍历前向、后向或双向返回节点和边find_orphans查找没有入链的笔记被遗忘的想法清理候选项find_broken_links查找无法解析的wiki-links批量重命名前运行2.3 写入功能create_note创建新笔记可选前置元数据和自动生成的## Related部分update_note替换笔记的完整内容append_to_note在笔记末尾追加markdown内容append_to_daily_note追加到今日的每日笔记常见模式代理记录其操作patch_note在特定标题、块或前置元数据字段下插入内容无需重写其余部分delete_note删除笔记仅在被明确要求时使用3. 使用场景该服务适合在以下情况下使用构建内容地图MOC使用traverse_graph从某个主题出发遍历2跳深度将邻居按主题分组并写入MOC项目管理查找所有标记为#project且状态不是done且截止日期在本周的项目笔记每日笔记管理检查今日每日笔记内容跟进昨日未完成事项清理孤立笔记查找Inbox/文件夹中的所有孤立笔记根据内容和现有标签建议归属位置批量重命名重命名笔记时查找所有链接到它的笔记并告知需要更新哪些图分析从某个概念出发遍历2跳找出对该主题思考最核心的笔记4. 接入方式4.1 服务端点该服务通过Local REST API插件连接到Obsidian默认主机127.0.0.1默认端口27124HTTPS/ 27123HTTP协议HTTPS默认使用自签名证书4.2 认证与权限该服务需要Obsidian Local REST API插件的API密钥从Obsidian的Community Plugins安装Local REST API插件启用插件并从设置中复制API密钥将API密钥配置到环境变量OBSIDIAN_API_KEY4.3 数据格式服务使用以下数据格式笔记格式Markdown链接格式[[wiki-links]]元数据YAML前置元数据查询语言Dataview DQL4.4 服务器配置在MCP客户端配置中添加服务{ mcpServers: { obsidian: { command: npx, args: [-y, obsidian-mcp], env: { OBSIDIAN_API_KEY: paste-your-key-here } } } }4.5 环境变量配置变量名必需默认值说明OBSIDIAN_API_KEY是-从Local REST API插件设置获取OBSIDIAN_HOST否127.0.0.1Obsidian主机地址OBSIDIAN_PORT否27124 (https) / 27123 (http)端口号OBSIDIAN_PROTOCOL否https协议类型OBSIDIAN_VERIFY_TLS否false是否验证TLS证书OBSIDIAN_TIMEOUT_MS否15000请求超时时间毫秒5. 接口定义工具名称功能描述关键参数get_note获取笔记内容及图上下文path: 笔记路径get_active_note获取当前聚焦的笔记无参数get_daily_note获取每日笔记type: daily/weekly/monthly/quarterly/yearlylist_vault列出vault文件folder: 文件夹路径可选search_vault搜索vault内容query: 搜索查询query_dataview运行Dataview查询query: DQL查询语句traverse_graph图遍历path: 起始笔记, depth: 跳数, direction: forward/backward/bothfind_orphans查找孤立笔记folder: 文件夹路径可选find_broken_links查找断开的链接无参数create_note创建新笔记path: 路径, content: 内容, frontmatter: 前置元数据可选update_note更新笔记内容path: 路径, content: 新内容append_to_note追加到笔记path: 路径, content: 追加内容append_to_daily_note追加到每日笔记content: 追加内容patch_note修补笔记path: 路径, heading/block/field: 目标位置, content: 内容delete_note删除笔记path: 笔记路径6. 快速开始6.1 环境要求Node.js建议v16或更高版本Obsidian应用程序Local REST API插件从Community Plugins安装Dataview插件可选用于query_dataview功能6.2 安装步骤步骤1安装Obsidian插件打开Obsidian进入设置 → Community plugins搜索并安装Local REST API插件启用插件并从设置中复制API密钥步骤2配置Claude DesktopmacOS编辑文件~/Library/Application Support/Claude/claude_desktop_config.json{ mcpServers: { obsidian: { command: npx, args: [-y, obsidian-mcp], env: { OBSIDIAN_API_KEY: your-api-key-here } } } }步骤3配置Claude DesktopWindows编辑文件%APPDATA%\Claude\claude_desktop_config.json{ mcpServers: { obsidian: { command: npx, args: [-y, obsidian-mcp], env: { OBSIDIAN_API_KEY: your-api-key-here } } } }步骤4重启Claude Desktop6.3 使用示例示例1构建内容地图 使用traverse_graph从Distributed systems.md出发深度2跳 将邻居按主题分组并写入MOCs/Distributed systems MOC.md 示例2项目管理 查找所有标记为#project且status ! done且截止日期在本周的项目笔记 示例3每日笔记 今日每日笔记有什么内容昨天笔记中有什么忘记跟进的吗 示例4清理孤立笔记 查找Inbox/文件夹中的所有孤立笔记根据内容和现有标签建议归属位置7. 注意事项重要提醒Obsidian必须打开Local REST API插件在Obsidian内部运行因此应用程序必须保持打开状态一个实例一个vault一个服务器实例指向一个运行中的Obsidian实例。如果频繁切换vault需要运行多个MCP服务器条目不同名称不同端口安全性MCP服务器授予模型API密钥所授予的任何访问权限。模型愿意删除的任何内容都可以删除。像对待任何具有文件写入访问权限的代理一样对待它——在批量操作之前检查它即将执行的操作HTTPS与TLS验证插件默认使用自签名证书流量仅限本地回环127.0.0.1因此验证增加了摩擦而没有真正的安全收益如果已替换证书请设置OBSIDIAN_VERIFY_TLStrue与其他解决方案的比较功能obsidian-mcp其他Obsidian MCP服务器Obsidian Copilot插件一次调用获取反向链接是否是多跳图遍历是否否Dataview DQL透传是否部分每日/周期性笔记是否否在标题/块下修补是否否查找孤立/断开的链接是否否适用于任何MCP客户端是是否仅限Obsidian工作原理┌──────────────┐ stdio (MCP) ┌──────────────┐ HTTPS ┌──────────────────┐ │ Claude / IDE │ ───────────────────► │ obsidian-mcp │ ───────────► │ Local REST API │ ──► Vault └──────────────┘ └──────────────┘ │ (Obsidian plugin)│ └──────────────────┘obsidian-mcp是Local REST API插件之上的薄层。该插件在Obsidian内部运行HTTPS服务器具有完整的vault访问权限此服务器将该表面适配为MCP协议并添加了Obsidian REST API不直接公开的图感知工具反向链接、多跳遍历、孤立检测。总结obsidian-mcp将Obsidian vault视为知识图谱而非简单的文件系统为MCP客户端提供了强大的图遍历、Dataview查询、每日笔记管理等功能。与其他仅提供基本文件读写的Obsidian MCP服务器不同它支持反向链接、多跳遍历、孤立检测等高级功能是知识管理和笔记自动化的理想工具。
返回列表