Obsidian Tasks MCP

🚀 Obsidian 任務 MCP 服務器

一個用於從 Markdown 文件中提取和查詢 Obsidian 任務的 Model Context Protocol (MCP) 服務器。該服務器專為與 Claude 配合使用而設計，通過 MCP 協議實現各項功能。

🚀 快速開始

安裝方式

• 使用 npm 包管理器安裝：

npm install -g @jfim/obsidian-tasks-mcp

• 從源碼構建：

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

運行方式

• 全局安裝後運行：

obsidian-tasks-mcp /path/to/vault

• 從源碼啟動：

node dist/index.js /path/to/vault

✨ 主要特性

• 任務提取：支持識別和解析多種格式的任務項。
• 時間信息：處理截止日期、計劃日期等時間信息。
• 優先級標識：識別高、中、低優先級標記。
• 重複任務：解析週期性重複任務。
• 標籤支持：提取並管理相關標籤。

📦 安裝指南

安裝方式

• 使用 npm 包管理器安裝：

npm install -g @jfim/obsidian-tasks-mcp

• 從源碼構建：

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

💻 使用示例

提取工具 (obsidian-tasks)

功能描述

用於從指定目錄及其子目錄中的所有 Markdown 文件中提取 Obsidian 格式任務信息。

基本用法

obsidian-tasks /path/to/obsidian-vault

高級用法

支持使用選項進行更靈活的操作：

• --recursive：遞歸遍歷所有子目錄。
• --filter：指定過濾條件（如特定標籤或日期範圍）。
• --output-format：設置輸出格式（支持 JSON、CSV 等）。

輸出示例

[
  {
    "id": "1",
    "description": "完成項目報告",
    "due-date": "2025-05-01",
    "tags": ["work", "report"],
    "priority": "high"
  },
  {
    "id": "2",
    "description": "回顧會議紀要",
    "scheduled-date": "2025-04-30",
    "start-date": "2025-04-28",
    "recurrence": "每週一次"
  }
]

查詢工具 (query)

功能描述

用於根據指定條件搜索和過濾提取的任務信息。

支持的查詢條件

• 標籤：#tag
• 時間範圍：due:YYYY-MM-DD..YYYY-MM-DD
• 優先級：priority:high/medium/low

示例用法

query --tag work --priority high /path/to/output.json

分析工具 (analyze)

功能描述

用於對提取的任務數據進行統計和分析，生成報告。

支持的分析類型

• 時間分佈：按日期統計任務數量。
• 標籤頻率：分析各標籤出現次數。
• 優先級分佈：統計不同優先級的任務比例。

示例用法

analyze /path/to/output.json --output report.html

使用 Docker

構建鏡像

docker build -t @jfim/obsidian-tasks-mcp .

運行容器

docker run -i --rm --mount type=bind,src=/path/to/vault,dst=/projects/vault @jfim/obsidian-tasks-mcp /projects

Claude Desktop 配置示例

{
  "mcpServers": {
    "obsidian-tasks": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--mount", "type=bind,src=/path/to/vault,dst=/projects/vault",
        "@jfim/obsidian-tasks-mcp",
        "/projects"
      ]
    }
  }
}

📚 詳細文檔

任務格式

支持以下 Obsidian 任務格式：

• 基本格式：- [ ] 任務描述
• 已完成任務：- [x] 任務描述
• 截止日期：🗓️ YYYY-MM-DD
• 計劃日期：⏳ YYYY-MM-DD
• 開始日期：🛫 YYYY-MM-DD
• 創建日期：➕ YYYY-MM-DD
• 優先級：⏫ (高), 🔼 (中), 🔽 (低)
• 重複任務：🔁 every day/week/month/etc.
• 標籤：#tag1 #tag2

示例：

- [ ] 完成項目報告 🗓️ 2025-05-01 ⏳ 2025-04-30 🔼

📄 許可證

本項目採用 MIT 協議開源。

🔗 貢獻與聯繫

貢獻指南

歡迎 fork 和提交 PR，共同完善此工具。

聯繫方式

如需反饋或討論，請聯繫：

• 郵箱：contact@jfim.com
• GitHub：https://github.com/jfim/obsidian-tasks-mcp

⚠️ 重要提示

本項目仍處於開發階段，部分功能可能尚未完善。請在使用前仔細閱讀文檔，並備份重要數據。