使用说明
项目简介
Obsidian MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在使 AI 助手能够安全、可扩展地访问和操作 Obsidian 知识库中的笔记。通过此服务器,AI 助手可以读取、创建、编辑、删除笔记,管理标签,以及在知识库中进行搜索,从而实现更智能的知识管理和应用集成。
主要功能点
- 笔记操作: 支持读取、创建、编辑、移动和删除 Obsidian 知识库中的笔记。
- 目录管理: 允许创建新的目录来组织笔记。
- 标签管理: 提供添加、移除和重命名标签的功能,方便知识分类和检索。
- 内容搜索: 支持在整个知识库中搜索笔记内容,快速定位信息。
- 安全访问控制: 通过 MCP 协议,提供安全可控的知识库访问方式。
- 可扩展工具: 允许开发者扩展新的工具,以满足更复杂的操作需求。
安装步骤
- 环境准备: 确保已安装 Node.js 20 或更高版本。
- 配置 Claude Desktop: 编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'。
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%\Claude\claude_desktop_config.json'
- 添加 MCP 服务器配置: 在 'claude_desktop_config.json' 文件中的 '"mcpServers"' 字段下,添加 Obsidian MCP Server 的配置信息。
服务器配置
以下是在 'claude_desktop_config.json' 中配置 Obsidian MCP Server 的示例:
{ "mcpServers": { "obsidian": { "command": "npx", "args": ["-y", "obsidian-mcp", "/path/to/your/vault"] } } }
配置参数说明:
- '"obsidian"': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。
- '"command": "npx"': 启动服务器的命令,这里使用 'npx' 运行 'obsidian-mcp' 包。
- '"args": ["-y", "obsidian-mcp", "/path/to/your/vault"]': 传递给 'npx' 命令的参数。
- '"-y"': 'npx' 参数,表示自动确认安装 'obsidian-mcp' 包。
- '"obsidian-mcp"': 要执行的 npm 包名,即 'obsidian-mcp'。
- '"/path/to/your/vault"': 需要替换为你的 Obsidian 知识库的绝对路径。例如:
- macOS/Linux: '"/Users/用户名/Documents/MyVault"'
- Windows: '"C:\Users\用户名\Documents\MyVault"'
注意:
- 请将 '"/path/to/your/vault"' 替换为你的实际 Obsidian 知识库路径。
- 确保路径是绝对路径。
- 配置完成后,重启 Claude Desktop 以加载新的服务器配置。
基本使用方法
配置并启动 Obsidian MCP Server 后,在支持 MCP 协议的 AI 客户端(如 Claude Desktop)中,即可通过以下工具与 Obsidian 知识库进行交互:
- 'read-note': 读取笔记内容。
- 'create-note': 创建新笔记。
- 'edit-note': 编辑现有笔记。
- 'delete-note': 删除笔记。
- 'move-note': 移动笔记。
- 'create-directory': 创建目录。
- 'search-vault': 搜索知识库。
- 'add-tags': 添加标签。
- 'remove-tags': 移除标签。
- 'rename-tag': 重命名标签。
- 'manage-tags': 管理标签(添加或移除)。
在 AI 客户端中,你可以指示 AI 助手使用这些工具来完成对 Obsidian 知识库的操作,例如:“请使用 'search-vault' 工具在我的 Obsidian 知识库中搜索关于 ‘项目进展’ 的笔记”。具体的工具调用方式和参数需要参考 AI 客户端的使用文档。
信息
分类
生产力应用