项目简介
Claudesidian MCP 插件是一个为 Obsidian 设计的插件,它实现了 MCP 服务器,允许 AI 助手(如 Claude Desktop)通过 Model Context Protocol 协议与您的 Obsidian Vault 进行无缝交互。该插件将 Obsidian Vault 的功能以 MCP 工具的形式暴露出来,为 AI 助手提供结构化的知识库访问和操作能力。
主要功能点
- MCP 服务器集成: 作为一个 MCP 服务器,插件能够响应来自 MCP 客户端的请求,例如资源列表、资源读取和工具调用。
- Vault 操作工具: 提供了一系列工具,允许 AI 助手在 Obsidian Vault 中执行各种操作,包括:
- 笔记管理: 创建、读取、更新和删除笔记。
- 文件夹管理: 创建、删除和移动文件夹。
- 内容搜索: 在 Vault 中搜索笔记内容和元数据。
- 笔记编辑: 进行精确的笔记内容编辑操作,例如在特定标题下插入内容、替换文本等。
- AI 文本生成工具: 集成了 AI 文本生成功能,允许 AI 助手根据用户 prompt 生成文本内容,并将生成结果保存到 Obsidian Vault 中。
- 命令面板工具: 允许 AI 助手执行 Obsidian 的命令面板中的命令,扩展了 AI 助手的操作能力。
- 项目管理工具: 提供项目规划、检查点设置和信息收集等项目管理相关操作。
- 安全控制: MCP 服务器仅接受本地连接,所有 Vault 操作都需要用户显式授权,数据存储在本地 Vault 中,确保数据安全。
安装步骤
- 下载插件文件: 从最新的 release 版本下载以下文件:
- 'manifest.json'
- 'styles.css'
- 'main.js'
- 'connector.js'
- 放置插件文件: 将下载的文件保存到 Obsidian Vault 的插件目录 'path/to/vault/.obsidian/plugins/claudesidian-mcp' 下 (如果 'claudesidian-mcp' 文件夹不存在,需要手动创建)。
- 启用插件: 在 Obsidian 的设置中启用 "Claudesidian MCP Plugin" 插件。
- 配置 Claude Desktop: 根据插件设置中的说明,配置您的 Claude Desktop 配置文件。
- 重启 Obsidian 和 Claude Desktop: 重启 Obsidian 使插件生效,并完全重启 Claude Desktop (可能需要在任务管理器中结束 Claude Desktop 进程)。
服务器配置
MCP 服务器配置信息 (JSON 格式),用于配置 MCP 客户端 (例如 Claude Desktop):
{ "mcpServers": { "claudesidian-mcp": { // 服务器名称,在客户端中用于标识和选择服务器 "command": "node", // 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件 "args": [ // 启动命令的参数,指定 connector.js 文件的路径 "path/to/vault/.obsidian/plugins/claudesidian-mcp/connector.js" // 请替换为您的 vault 中 connector.js 的实际路径 ] } } }
注意:
- 'args' 中的路径需要根据您的 Obsidian Vault 插件目录的实际位置进行调整。
- MCP 客户端 (如 Claude Desktop) 需要读取并应用此配置才能连接到 Claudesidian MCP 服务器。
- 服务器默认通过 Stdio 和 IPC (Named Pipes on Windows, Unix domain sockets on macOS/Linux) 协议与客户端通信。
基本使用方法
- 安装和启用插件: 按照安装步骤完成插件的安装和启用。
- 配置 Claude Desktop: 将上述服务器配置信息添加到 Claude Desktop 的配置文件中,并重启 Claude Desktop。
- 在 Claude Desktop 中使用: Claude Desktop 应该能够检测到 Claudesidian MCP 服务器。您可以在 Claude Desktop 中配置和使用连接到 Obsidian Vault 的 AI 助手,利用插件提供的各种工具进行笔记操作、信息检索和 AI 辅助写作等任务。
- 工具调用: AI 助手可以通过 MCP 协议调用插件提供的工具,例如让 AI 助手读取指定笔记的内容、创建新的笔记、搜索 Vault 中的信息等。
信息
分类
生产力应用