Obsidian MCP 服务器使用说明
项目简介
Obsidian MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,它通过一系列工具,使得大型语言模型 (LLM) 能够与您的 Obsidian 笔记库进行交互。通过此服务器,LLM 可以读取、搜索、修改您的 Obsidian 笔记,从而实现更智能的知识管理和信息处理。
主要功能点
- 文件列表: 列出 Obsidian Vault 根目录或指定目录下的文件和文件夹。
- 文件内容获取: 获取 Obsidian Vault 中指定文件的内容。
- 内容搜索: 在 Obsidian Vault 中搜索包含特定文本的文件,并返回匹配的上下文。支持简单文本搜索和基于 JsonLogic 的复杂查询。
- 内容修改: 向 Obsidian Vault 中已存在的文件追加内容或在指定位置插入内容(支持根据标题、块引用或 frontmatter 字段定位)。
安装步骤
-
安装 Obsidian Local REST API 插件:
- 在 Obsidian 中,打开设置 -> 社区插件,关闭安全模式(如果已启用),然后启用社区插件。
- 浏览并安装 "Local REST API" 插件。
- 在插件设置中,启用插件并复制 API 密钥 (API Key)。
-
安装 Claude 桌面应用 (如果使用 Claude):
- 如果您计划将此 MCP 服务器与 Claude 桌面应用一起使用,请确保已安装 Claude 桌面应用。
-
配置 Claude 桌面应用 (如果使用 Claude):
- 打开 Claude 桌面应用的配置文件 'claude_desktop_config.json'。
- MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
- 在 'mcpServers' 字段中添加 'mcp-obsidian' 服务器的配置信息(如下服务器配置部分所示)。
- 打开 Claude 桌面应用的配置文件 'claude_desktop_config.json'。
服务器配置
要将 Obsidian MCP 服务器配置为 Claude 桌面应用的 MCP 服务器,您需要在 'claude_desktop_config.json' 文件中添加以下 JSON 配置。 请注意,您需要将 '<YOUR_OBSIDIAN_API_KEY>' 替换为您在 Obsidian Local REST API 插件设置中获取的 API 密钥。
{ "mcpServers": { "mcp-obsidian": { "command": "uvx", "args": [ "mcp-obsidian" ], "env": { "OBSIDIAN_API_KEY": "<YOUR_OBSIDIAN_API_KEY>" } } } }
配置参数说明:
- 'server name': 'mcp-obsidian' (服务器名称,在 Claude 桌面应用中用于标识此服务器)
- 'command': 'uvx' (执行命令,'uvx' 是一个用于运行 Python 包的工具,确保您的环境中已安装 'uv' 或 'uvx')
- 'args': '["mcp-obsidian"]' (传递给 'uvx' 命令的参数,指定要运行的 Python 包为 'mcp-obsidian')
- 'env': 环境变量配置
- 'OBSIDIAN_API_KEY': '<YOUR_OBSIDIAN_API_KEY>' (Obsidian Local REST API 插件生成的 API 密钥,请替换为您的实际密钥)
注意:
- 确保您的 Obsidian Vault 和 Local REST API 插件已正确配置并运行。
- 您需要在运行 MCP 客户端的环境中安装 'uv' 或 'uvx' 工具。
- 环境变量 'OBSIDIAN_API_KEY' 是连接 Obsidian REST API 的关键,请务必正确配置。
基本使用方法
配置完成后,当在支持 MCP 协议的 LLM 客户端(例如 Claude 桌面应用)中指示 LLM 与 Obsidian 交互时,LLM 就可以调用此 MCP 服务器提供的工具来访问和操作您的 Obsidian 笔记库。
示例使用场景:
- 让 Claude 总结最近一次架构会议的笔记:
- "Get the contents of the last architecture call note and summarize them"
- 让 Claude 搜索关于 Azure CosmosDb 的笔记并解释相关上下文:
- "Search for all files where Azure CosmosDb is mentioned and quickly explain to me the context in which it is mentioned"
- 让 Claude 总结最近的会议纪要并保存到新的 Obsidian 笔记中:
- "Summarize the last meeting notes and put them into a new note 'summary meeting.md'. Add an introduction so that I can send it via email."
信息
分类
生产力应用