mcp-obsidian

🚀 MCP Obsidian

MCP Obsidian是为Obsidian保险库集成打造的Model Context Protocol服务器端工具。它支持Claude Desktop（或其他MCP客户端）搜索和阅读你的Obsidian笔记，让信息的获取更加便捷高效。

🚀 快速开始

⚙️ 先决条件

• Node.js 18+，可通过brew install node进行安装。
• 拥有一个Obsidian保险库。
• 安装Claude Desktop，可从这里下载并安装。

⚙️ 配置步骤

1. 打开Claude Desktop配置文件，其路径为：~/Library/Application Support/Claude/claude_desktop_config.json。 你可以按以下方式找到该文件：
   1. 打开Claude Desktop。
   2. 点击菜单栏中的“Claude”。
   3. 选择“设置”。
   4. 再次点击“开发者”。
2. 在配置文件中添加以下内容：

{
  "tools": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-obsidian"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

⚠️ 重要提示：请将/path/to/your/obsidian/vault替换为你的实际Obsidian保险库路径。

🛠️ 开发者指南

⚙️ 先决条件

• Node.js 18+，可通过brew install node进行安装。
• 拥有一个Obsidian保险库。
• 安装Claude Desktop，可从这里下载并安装。
• 安装tsx，可通过npm install -g tsx进行安装。

📦 安装步骤

git clone https://github.com/kazuph/mcp-obsidian.git
cd mcp-obsidian
npm install
npm run build

⚙️ 配置指南

1. 确保Claude Desktop已安装并处于运行状态。
2. 如果尚未安装tsx，可进行全局安装：

npm install -g tsx
# 或者使用pnpm
pnpm add -g tsx

3. 修改Claude Desktop配置文件，路径为：~/Library/Application Support/Claude/claude_desktop_config.json。 可通过以下步骤轻松找到该文件：
   1. 打开Claude Desktop。
   2. 点击菜单栏中的“Claude”。
   3. 选择“设置”。
   4. 再次点击“开发者”。 在配置文件中添加以下内容：

{
  "tools": {
    "obsidian": {
      "args": ["tsx", "/path/to/mcp-obsidian/index.ts"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

✨ 主要特性

🛠️ 可用工具

• obsidian_read_notes：可读取多个笔记的内容，每个笔记的内容将与其路径一同返回。
• obsidian_search_notes：按名称搜索笔记（不区分大小写，支持部分匹配和正则表达式）。
• obsidian_read_notes_dir：列出指定路径下的目录结构。
• obsidian_write_note：在指定路径下创建新笔记。