简介

一个本地的MCP服务器， enables像Claude Desktop这样的AI应用安全地访问和处理Obsidian保险库，提供阅读笔记、执行模板和进行语义搜索的功能。

简介

一个本地的MCP服务器， enables像Claude Desktop这样的AI应用安全地访问和处理Obsidian保险库，提供阅读笔记、执行模板和进行语义搜索的功能。

MCP Tools for Obsidian

功能 | 安装 | 配置 | 故障排除 | 安全 | 开发 | 支持

MCP Tools for Obsidian 使像 Claude Desktop 这样的 AI 应用程序能够通过 Model Context Protocol (MCP) 安全地访问和操作您的 Obsidian 知识库。MCP 是一种开放协议，它标准化了 AI 应用程序如何与外部数据源和工具进行交互，同时保持安全性和用户控制。¹

此插件由两部分组成：

1. 一个为您的知识库添加 MCP 功能的 Obsidian 插件
2. 一个处理与 AI 应用程序通信的本地 MCP 服务器

当您安装此插件时，它将帮助您设置这两个组件。MCP 服务器充当您的知识库和像 Claude Desktop 这样的 AI 应用程序之间的安全桥梁。这意味着 AI 助手可以阅读您的笔记、执行模板并执行语义搜索——但只有在您允许的情况下，并且只能通过服务器的安全 API。服务器永远不会让 AI 应用程序直接访问您的知识库文件。²

隐私说明：使用此插件与 Claude Desktop 时，默认情况下，您与 Claude 的对话不会用于训练 Anthropic 的模型。³

功能

当连接到像 Claude Desktop 这样的 MCP 客户端时，此插件启用以下功能：

• 知识库访问：允许 AI 助手在保持知识库安全的同时阅读和引用您的笔记⁴
• 语义搜索：AI 助手可以根据意义和上下文而不是仅根据关键词搜索您的知识库⁵
• 模板集成：通过 AI 交互执行 Obsidian 模板，具有动态参数和内容生成功能⁶

所有功能都需要像 Claude Desktop 这样的兼容 MCP 的客户端，因为此插件提供了实现这些集成的服务器组件。该插件不会直接修改 Obsidian 的功能——相反，它创建了一个安全的桥梁，使 AI 应用程序能够以强大的方式与您的知识库协同工作。

前提条件

必需

• Obsidian v1.7.7 或更高版本
• 已安装并配置的 Claude Desktop
• 已安装并配置有 API 密钥的 Local REST API 插件

推荐

• Templater 插件，以增强模板功能
• Smart Connections 插件，以提供语义搜索功能

安装

[!Important] 该插件需要一个在您的计算机上本地运行的安全服务器组件。服务器以签名的可执行文件形式分发，其完整的源代码可在 packages/mcp-server/ 中找到。有关我们的安全措施和代码签名过程的详细信息，请参阅安全性部分。

1. 从 Obsidian 的社区插件中安装插件
2. 在 Obsidian 设置中启用插件
3. 打开插件设置
4. 点击“安装服务器”以下载并配置 MCP 服务器

点击安装按钮将：

• 下载适用于您平台的 MCP 服务器二进制文件
• 配置 Claude Desktop 以使用服务器
• 设置必要的权限和路径

安装位置

• 服务器二进制文件：{vault}/.obsidian/plugins/obsidian-mcp-tools/bin/
• 日志文件：
  • macOS: ~/Library/Logs/obsidian-mcp-tools
  • Windows: %APPDATA%\obsidian-mcp-tools\logs
  • Linux: ~/.local/share/obsidian-mcp-tools/logs

配置

在插件设置中点击“安装服务器”按钮后，插件将自动：

1. 下载适当的 MCP 服务器二进制文件
2. 使用您的 Local REST API 插件的 API 密钥
3. 配置 Claude Desktop 以使用 MCP 服务器
4. 设置适当的路径和权限

虽然配置过程是自动化的，但它需要您的明确许可来安装服务器二进制文件并修改 Claude Desktop 配置。除了这个初始设置步骤外，不需要额外的手动配置。

故障排除

如果您遇到问题：

1. 检查插件设置以确认：
   • 所有必需的插件都已安装
   • 服务器已正确安装
   • Claude Desktop 已配置
2. 查看日志：
   • 打开插件设置
   • 在资源下点击“打开日志”
   • 查找任何错误消息或警告
3. 常见问题：
   • 服务器无法启动：确保 Claude Desktop 正在运行
   • 连接错误：验证 Local REST API 插件是否已配置
   • 权限错误：尝试重新安装服务器

安全性

二进制分发

• 所有版本均使用 GitHub Actions 构建，并具有可重复构建
• 二进制文件通过 SLSA 来源进行签名和证明
• 发布工作流在存储库中完全可审计

运行时安全

• MCP 服务器以最小所需权限运行
• 所有通信都是加密的
• API 密钥使用特定于平台的凭据存储安全地存储

二进制验证

MCP 服务器二进制文件发布时带有 SLSA Provenance attestations，这提供了二进制文件构建地点和方式的加密证明。这有助于确保您下载的二进制文件的完整性和来源。

要使用 GitHub CLI 验证二进制文件：

1. 安装 GitHub CLI：

   # macOS (Homebrew)
   brew install gh
   
   # Windows (Scoop)
   scoop install gh
   
   # Linux
   sudo apt install gh  # Debian/Ubuntu
   

2. 验证二进制文件：

   gh attestation verify --owner jacksteamdev <二进制文件路径或URL>
   

验证将显示：

• 二进制文件的 SHA256 哈希值
• 确认该文件是由此仓库的 GitHub Actions 工作流构建的
• 创建它的具体工作流文件和版本标签
• 符合 SLSA Level 3 构建要求

这种验证确保了二进制文件未被篡改，并且直接从本仓库的源代码构建而成。

报告安全问题

请通过我们的安全政策报告安全漏洞。 不要在公开的问题中报告安全漏洞。

开发

本项目使用单仓库结构，基于功能架构。有关详细的项目架构文档，请参阅 .clinerules。

使用 Cline

本项目中的一些代码是使用 AI 编码代理 Cline 实现的。Cline 使用 cline_docs/ 和 .clinerules 文件来理解项目架构和模式，以便在实现新功能时使用。

工作区

本项目使用 Bun 的工作区结构：

packages/
├── mcp-server/        # Server implementation
├── obsidian-plugin/   # Obsidian plugin
└── shared/           # Shared utilities and types

构建

1. 安装依赖项：

   bun install
   

2. 构建所有包：

   bun run build
   

3. 对于开发：

   bun run dev
   

要求

• bun v1.1.42 或更高版本
• TypeScript 5.0+

贡献

1. 分叉仓库
2. 创建一个特性分支
3. 进行修改
4. 运行测试：

   bun test
   

5. 提交拉取请求

请参阅 CONTRIBUTING.md 获取详细指南。

支持

• 打开一个问题 报告错误或提出功能请求
• 发起讨论 提问或获取一般帮助

更新日志

查看 CHANGELOG.md 了解每个版本的更改列表。

许可证

MIT 许可证

脚注

来源

• 来源：github
• 链接：https://github.com/jacksteamdev/obsidian-mcp-tools

Footnotes

1. 有关模型上下文协议的更多信息，请参见 MCP 介绍 ↩

2. 有关可用的 MCP 客户端列表，请参见 MCP 示例客户端 ↩

3. 关于 Claude 数据隐私和安全的信息，请参见 Claude AI 的数据使用政策 ↩

4. 需要 Obsidian 插件 Local REST API ↩

5. 需要 Obsidian 插件 Smart Connections ↩

6. 需要 Obsidian 插件 Templater ↩