Obsidian MCP服务器插件

Obsidian MCP服务器插件是一个本地运行的Model Context Protocol(MCP)服务器,允许外部AI工具连接Obsidian,读取活动上下文并直接在应用内执行操作。

  • by Leonezz
  • TypeScript
  • 云端部署
  • 4 星标
  • 更新于
在 GitHub 查看 Leonezz/obsidian-mcp-server

使用说明

黑曜石MCP服务器

给你的AI代理一个座位。

此插件运行本地 模型上下文协议(MCP) 黑曜石内部的服务器。它允许外部AI工具(如Claude Desktop、Cursor或CLI代理)连接到Obsidian,读取您的活动上下文,并直接在应用程序中执行操作。

⚠️ 状态: Beta(生产就绪逻辑)。

特性

  • 情境感知: get_active_file 让代理确切地看到你在做什么。
  • 保险库访问: read_note, get_note_metadata, get_backlinks,以及 describe_vault 提供完整的保险库可见性。
  • 注释管理: create_note, edit_note, append_note, patch_note, rename_note,以及 delete_note 允许代理管理您的笔记。
  • 附件处理: read_attachment 将图像作为MCP ImageContent返回(AI可以看到它们); add_attachment 将二进制文件保存到vault。
  • 搜索: search_notes 按日期/标签/frontmatter过滤; search_content 使用行号片段和可选元数据进行全文或正则表达式搜索。
  • 快速捕获: append_daily_note 使用您的每日笔记设置(正确创建/附加)。
  • 发现: list_folder (带排序、过滤、递归), list_all_tags, list_recent_notes,以及 create_folder 帮助特工探索和组织金库。
  • 会话跟踪: list_sessions 显示具有客户端名称/版本和每个会话工具使用统计信息的活动连接。
  • 使用统计: 在设置中跟踪工具调用计数(总数/成功/失败),并使用持久存储。
  • 安全: 使用本地 身份验证令牌 通过时间安全比较。可以禁用身份验证以进行本地开发。
  • 访问控制: 将路径和标签列入黑名单,以保护敏感笔记的隐私。

建筑

  • 运输: 流式HTTP。
  • 端点: http://localhost:<PORT>/mcp
  • 安全: 承载令牌身份验证(默认启用,可以在设置中禁用)。

可用工具

工具 说明
get_active_file 获取当前活动笔记的内容和元数据
read_note 按vault相对路径读取注释
create_note 在给定路径创建新笔记(自动创建父文件夹,防止覆盖)
edit_note 替换现有注释的全部内容
append_note 在现有注释中添加或预置文本
patch_note 查找并替换注释上的编辑(无需完全重写)
rename_note 重命名或移动笔记(黑曜石自动更新维基链接)
delete_note 按路径删除注释
read_attachment 读取二进制附件——返回的图像为ImageContent(AI可以看到它们)
add_attachment 将base64编码的文件保存到vault(尊重Obsidian的附件文件夹设置)
get_note_metadata 获取无完整内容的首页、标签、标题和链接
get_backlinks 获取笔记的传入链接(反向链接)
list_folder 使用排序、文件类型筛选和递归列表列出文件/文件夹
list_all_tags 列出vault中所有带有使用次数的标签
list_recent_notes 最近修改的笔记,按最新顺序排列(默认10个,最多50个)
create_folder 创建一个文件夹(使用中间父文件夹,如 mkdir -p)
search_notes 按日期范围、标签和/或正文字段筛选笔记
search_content 使用行号片段、可选文件夹范围和元数据进行全文或正则表达式搜索
describe_vault Vault概述:名称、文件/文件夹计数、总大小、文件类型细分、标记计数
append_daily_note 将文本添加到今天的每日笔记中
list_sessions 列出活动的MCP会话,包括客户端信息和每个会话的工具统计数据

所有工具在返回数据之前都会执行访问控制规则。

安装

方法1:BRAT(Beta)

  1. 安装 兄弟 来自社区插件。
  2. 添加测试插件: Leonezz/obsidian-mcp-server
  3. 启用“黑曜石MCP服务器”。

配置

  1. 首选 设置->黑曜石MCP服务器.
  2. 注意你的 服务器端口 (默认值: 27123).
  3. 复制您的 身份验证令牌 (或禁用本地开发的“要求身份验证”)。
  4. 可选配置 访问控制 路径和标签的黑名单规则。

与MCP客户端一起使用

服务器使用 可流式传输的HTTP 运输 http://localhost:<PORT>/mcp.

提示: 如果在设置中禁用了“要求身份验证”,请省略 Authorization 头球 headers 阻止以下所有配置。

克劳德代码

Claude Code原生支持流式HTTP。通过CLI添加服务器:

claude mcp add --transport http obsidian http://localhost:27123/mcp \
  --header "Authorization: Bearer YOUR_TOKEN"

或者将其添加到您的项目中 .mcp.json:

{
  "mcpServers": {
    "obsidian": {
      "type": "http",
      "url": "http://localhost:27123/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

光标

增添 ~/.cursor/mcp.json (全球)或 .cursor/mcp.json (工作空间):

{
  "mcpServers": {
    "obsidian": {
      "type": "streamable-http",
      "url": "http://localhost:27123/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

帆板运动

增添 ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "obsidian": {
      "serverUrl": "http://localhost:27123/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

注: 风帆用途 "serverUrl" 而不是 "url".

克劳德桌面版

Claude Desktop在其配置文件中不支持Streamable HTTP。使用 mcp-remote 代理:

增添 ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)或 %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://localhost:27123/mcp",
        "--header",
        "Authorization: Bearer YOUR_TOKEN"
      ]
    }
  }
}

开爪

OpenClaw尚未原生支持MCP。使用捆绑的 OpenClaw技能 相反,它教导代理通过以下方式与服务器通信 curl 和 jq.

安装技能:

cp -r openclaw-skill/ ~/.openclaw/workspace/skills/obsidian-mcp/

设置身份验证令牌:

export OBSIDIAN_MCP_TOKEN="YOUR_TOKEN"

可选设置 OBSIDIAN_MCP_PORT (默认值 27123)以及 OBSIDIAN_MCP_HOST (默认值 127.0.0.1).

安装后,OpenClaw将自动发现该技能,并可以在您的保管库中阅读、搜索、创建和编辑笔记。

其他客户

任何支持Streamable HTTP的MCP客户端都可以使用以下方式连接:

  • 网址: http://localhost:27123/mcp
  • 头球 Authorization: Bearer YOUR_TOKEN

AI代理说明

如果您是帮助用户连接到此MCP服务器的AI代理:

  1. 验证安装: 检查用户是否正在运行Obsidian obsidian-mcp-server 插件已启用。
  2. 检索连接信息: 向用户询问:
    • 这 服务器端口 (默认值 27123).
    • 这 身份验证令牌 (来自黑曜石设置),除非他们已禁用身份验证。
  3. 检测客户端: 确定用户正在运行哪个MCP客户端(Claude Code、Cursor、Windsurf、Claude Desktop等),并使用上述部分中的匹配配置格式。
  4. 配置并重新启动: 将服务器定义插入到相应的配置文件中,并告诉用户重新启动他们的MCP客户端。