Obsidian MCP Server

Obsidian MCP Server

site icon
2025.03.09 12
TypeScript笔记管理AI 助手集成开发效率
Obsidian MCP Server 是一个轻量级的 Model Context Protocol (MCP) 服务器,旨在为 AI 助手(如 Cursor 和 Claude)提供读取和写入 Obsidian 知识库的能力。它通过提供一系列工具,使得 AI 助手能够与用户的 Obsidian 笔记进行交互,包括创建新笔记、读取现有笔记内容以及管理待办事项等。
View on GitHub

Overview

基本能力

产品定位

Obsidian MCP Server 是一个连接 AI 助手与 Obsidian 知识库的桥梁,使得 AI 助手能够直接与用户的笔记进行交互。

核心功能

  1. 读取功能
  2. getAllFilenames: 获取 Obsidian 知识库中所有文件的名称列表。
  3. readMultipleFiles: 读取指定文件的内容,支持文件名精确匹配、部分匹配及大小写不敏感匹配。
  4. getOpenTodos: 获取所有未完成的待办事项(即未勾选的复选框项)。

  5. 写入功能

  6. updateFileContent: 更新或创建指定文件的内容,自动创建必要的目录结构。

适用场景

  • AI 助手帮助用户创建新的笔记或更新现有笔记。
  • 快速查找和检索笔记内容。
  • 管理待办事项和任务列表。

工具列表

  1. getAllFilenames: 用于发现知识库中可用的文件。
  2. readMultipleFiles: 用于读取多个文件的内容,便于 AI 助手进行内容分析。
  3. getOpenTodos: 用于获取所有未完成的待办事项,帮助用户管理任务。
  4. updateFileContent: 用于更新或创建文件内容,支持 AI 助手直接修改笔记。

常见问题解答

  • Q: 是否需要 Obsidian 应用程序运行才能使用此服务器? A: 不需要,此服务器直接访问文件系统,无需 Obsidian 应用程序运行。
  • Q: 与其他解决方案相比有何优势? A: 此服务器轻量级,直接访问文件系统,无需依赖 Obsidian 插件。

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

npm install obsidian-mcp-server
npm run build

调试方式

  1. 集成 Claude Desktop: 在 Claude 配置中添加以下内容: json { "mcpServers": { "obsidian": { "command": "node", "args": [ "obsidian-mcp-server/build/index.js", "/path/to/your/vault" ] } } }

  2. 集成 Cursor: 在 Cursor 的 MCP 选项卡中添加服务器命令: bash node obsidian-mcp-server/build/index.js /path/to/your/vault

许可证

None