Obsidian MCP (模型上下文协议)

Obsidian MCP 是一个工具，允许您通过模型上下文协议与您的 Obsidian 保险库进行交互。这使得 AI 助手能够通过标准化接口读取、写入和操作您的 Obsidian 保险库中的笔记。

预备条件

• Node.js 18 或更高版本
• 已安装并配置了 Local REST API 插件 的 Obsidian
• 从 Local REST API 插件生成的 API 密钥

设置 MCP 服务器（例如 Claude 桌面应用）

1. 克隆此仓库

2. 安装依赖项：

   npm install
   

3. 构建项目：

   npm run build
   

4. 配置 Claude 桌面应用以使用此 MCP 服务器：

   {
      "mcpServers": {
        "Obsidian": {
          "command": "node",
          "args": ["/Users/<您的路径>/obsisian-mcp/build/index.js"],
          "env": {
            "apiKey": "<您的 API 令牌>",
            "port": "27123",
            "host": "127.0.0.1"
          }
        }
      }
    }
   

开发

创建 .env 文件，并根据上述内容配置 "apiKey"、"port" 和 "host"。

可用工具

以下工具已实现：

1. readNote - 读取特定笔记的内容

   {
     "path": "path/to/note.md"
   }
   

2. readActiveNote - 读取当前活动笔记的内容

   {}
   

3. listNotes - 递归列出整个保险库或指定文件夹下的所有文件和文件夹

   {
     "path": "可选的文件夹路径"
   }
   

4. patchNote - 在现有笔记中相对于标题、块引用或元数据字段插入内容

   {
     "path": "path/to/note.md",
     "operation": "append|prepend|replace",
     "targetType": "heading|block|frontmatter",
     "target": "目标标识符",
     "content": "要插入的内容"
   }
   

5. searchWithJsonLogic - 使用 JsonLogic 格式的查询搜索 Obsidian 笔记

   {
     "query": {
       // JsonLogic 查询对象
     }
   }