Obsidian MCP Server 使用说明
项目简介
Obsidian MCP Server 是一个轻量级的 MCP 服务器,它允许 AI 助手(如 Claude 和 Cursor)连接到您的本地 Obsidian 知识库。通过此服务器,AI 助手可以读取您的笔记内容、查找未完成的 TODO 项、以及创建或更新笔记文件,从而实现更智能的知识管理和辅助创作。
主要功能点
- 访问 Obsidian 笔记文件:允许 AI 助手读取您 Obsidian 知识库中的 Markdown 文件内容,支持按文件名精确或模糊查找。
- 检索未完成的 TODO:可以快速找出所有笔记中未勾选的 TODO 任务,方便您了解待办事项。
- 更新笔记内容:支持 AI 助手创建新笔记或修改现有笔记的内容,实现 AI 辅助的内容创作和知识库维护。
- 独立运行:作为一个独立的服务器运行,无需启动 Obsidian 应用程序,直接访问文件系统,效率更高。
安装步骤
- 确保 Node.js 和 npm 已安装:请先确保您的电脑上安装了 Node.js 和 npm 包管理器。
- 克隆仓库:在终端中使用 'git clone https://github.com/marcelmarais/obsidian-mcp-server.git' 命令克隆仓库到本地。
- 进入项目目录:使用 'cd obsidian-mcp-server' 命令进入项目目录。
- 安装依赖:运行 'npm install' 命令安装项目所需的依赖包。
- 构建项目:运行 'npm run build' 命令构建项目,生成可执行的服务器代码。
服务器配置
要将 Obsidian MCP Server 集成到 MCP 客户端(如 Claude Desktop 或 Cursor),您需要配置客户端以连接到此服务器。以下是配置示例(JSON 格式):
{ "mcpServers": { "obsidian": { "command": "node", "args": [ "obsidian-mcp-server/build/index.js", "/path/to/your/vault" // 将 "/path/to/your/vault" 替换为您 Obsidian 知识库的实际路径 ] } } }
配置参数说明:
- 'server name': 服务器名称,可以自定义,例如 "obsidian"。
- 'command': 启动服务器的命令,这里是 "node",表示使用 Node.js 运行。
- 'args': 命令参数数组,包括:
- '"obsidian-mcp-server/build/index.js"': 构建后的服务器主程序入口文件路径。
- '"/path/to/your/vault"': 请务必替换为您的 Obsidian 知识库在您电脑上的绝对路径。 例如:'"/Users/yourusername/Documents/ObsidianVault"'。
基本使用方法
- 启动服务器:打开终端,进入 'obsidian-mcp-server' 目录,运行命令 'node build/index.js /path/to/your/vault' (请将 '/path/to/your/vault' 替换为您的实际知识库路径)。服务器成功启动后,会在终端输出运行日志。
- 配置 MCP 客户端:根据您使用的 MCP 客户端(如 Claude Desktop 或 Cursor)的配置方法,填入上面提供的 JSON 配置信息。确保将 vault 路径配置正确。
- 使用 AI 助手:配置完成后,在您的 AI 助手中使用自然语言指令即可访问和操作您的 Obsidian 知识库。例如,您可以让 AI 助手:
- "查找关于项目 X 的笔记"
- "我的待办事项有哪些?"
- "创建一个名为 '会议纪要' 的新笔记,内容为今天会议的总结"
信息
分类
数据库与文件