Obsidian笔记交互协议

黑曜石MCP（模型上下文协议）

黑曜石MCP是一个工具，允许您使用模型上下文协议与黑曜石库进行交互。这使AI助手能够通过标准化的界面读取、写入和操作黑曜石金库中的笔记。

先决条件

• Node.js 18或更高版本
• 黑曜石与 本地REST API插件 已安装并配置
• 从本地REST API插件生成的API密钥

设置MCP服务器（例如克劳德桌面应用程序）

1. 克隆此存储库

2. 安装依赖项：

   复制

   npm install
   

3. 构建项目：

   复制

   npm run build
   

4. 配置Claude Desktop App以使用此MCP服务器：

   复制

   {
      "mcpServers": {
        "Obsidian": {
          "command": "node",
          "args": ["/Users/<Your Own Path>/obsisian-mcp/build/index.js"],
          "env": {
            "apiKey": "<Your API Token>",
            "port": "27123",
            "host": "127.0.0.1"
          }
        }
      }
    }
   

发展

创建 .env 并如上所述配置“apiKey”、“端口”和“主机”。

可用工具

实施了以下工具：

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

   复制

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

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

   复制

   {}
   

3. list备注 -递归列出整个Vault中或指定文件夹下的文件和文件夹

   复制

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

4. patchNote -将内容插入到与标题、块参照或前体字段相关的现有注释中

   复制

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

5. 使用JsonLogic进行搜索 -使用JsonLogic格式查询搜索黑曜石笔记

   复制

   {
     "query": {
       // JsonLogic query object
     }
   }