Obsidian MCP

🚀 Obsidian MCP (模型上下文協議)

Obsidian MCP是一款工具，它允許你通過模型上下文協議與你的Obsidian知識庫進行交互。藉助標準化接口，該工具能讓AI助手讀取、寫入和操作你Obsidian知識庫中的筆記。

🚀 快速開始

🔍 前提條件

• Node.js 18 或更高版本
• 安裝並配置了 本地REST API插件 的Obsidian
• 從本地REST API插件生成的API密鑰

📦 安裝指南

設置MCP服務器（例如Claude桌面應用）

1. 克隆此倉庫。
2. 安裝依賴項：

   npm install
   

3. 構建項目：

   npm run build
   

4. 配置Claude桌面應用以使用此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"、"port" 和 "host"。

可用工具

以下是已實現的工具：

基礎用法

• readNote - 讀取特定筆記的內容

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

• readActiveNote - 讀取當前活動筆記的內容

  {}
  

• listNotes - 遞歸列出整個知識庫或指定文件夾下的文件和文件夾

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

高級用法

• patchNote - 相對於標題、塊引用或前置元數據字段，將內容插入到現有筆記中

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

• searchWithJsonLogic - 使用JsonLogic格式的查詢搜索Obsidian筆記

  {
    "query": {
      // JsonLogic查詢對象
    }
  }