Obsidian MCP (模型上下文协议)

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

前提条件

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

设置 MCP 服务器 (例如 Claude Desktop App)

1. 克隆此仓库

2. 安装依赖项：

   npm install
   

3. 构建项目：

   npm run build
   

4. 配置 Claude Desktop App 以使用此 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 - 递归地列出整个 Vault 或指定文件夹中的文件和文件夹

   {
     "path": "optional/folder/path"
   }
   

4. patchNote - 将内容插入到现有笔记中，相对于标题、块引用或 frontmatter 字段

   {
     "path": "path/to/note.md",
     "operation": "append|prepend|replace",
     "targetType": "heading|block|frontmatter",
     "target": "target_identifier",
     "content": "content to insert"
   }
   

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

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