MCP Todoist

🚀 MCP-Todoist 項目說明

MCP-Todoist 是一款可與 Todoist 服務進行交互的應用程序。藉助該項目，你能夠在終端或其他支持 MCP（Multi-Command Processor）的環境中，直接管理任務與項目。

🚀 快速開始

在使用 MCP-Todoist 前，你需要完成安裝和配置，以下是詳細步驟。

📦 安裝指南

要安裝 MCP-Todoist，請按以下步驟操作：

# 克隆此倉庫到本地
git clone https://github.com/yourusername/mcp-todoist.git
cd mcp-todoist

# 使用 Python 包管理工具 pip 進行安裝
pip install .

# 安裝完成後，測試 MCP-Todoist 是否正常工作
mcp --help

⚙️ 項目配置

在使用 MCP-Todoist 前，請先完成以下配置：

1. 獲取 Todoist API 密鑰：訪問 Todoist 網站，登錄賬戶，然後進入設置頁面獲取 API 訪問令牌。
2. 創建配置文件：在項目根目錄下創建一個名為 config.json 的文件，並添加以下內容：

{
  "todoist": {
    "token": "your_api_token_here"
  }
}

💻 使用示例

基礎用法

1. 創建新任務

要創建新的 Todoist 任務，請運行以下命令：

mcp todoist create-task --title "任務標題" [--due-date YYYY-MM-DD]

• --title：必填參數，指定任務的標題。
• --due-date：可選參數，指定任務的截止日期。

例如：

mcp todoist create-task --title "購買雜貨" --due-date 2023-10-25

2. 查詢任務

要查詢 Todoist 中的任務，請使用以下命令：

按項目查詢

mcp todoist list-tasks --project "項目名稱"

例如：

mcp todoist list-tasks --project 工作

按標籤查詢

mcp todoist list-tasks --label "標籤名"

例如：

mcp todoist list-tasks --label 重要

3. 更新任務狀態

要更新任務的完成狀態，請運行以下命令：

標記任務為完成

mcp todoist complete-task --task-id ID

例如：

mcp todoist complete-task --task-id 12345678

標記任務為未完成

mcp todoist uncomplete-task --task-id ID

例如：

mcp todoist uncomplete-task --task-id 12345678

4. 添加備註到任務

要向任務添加備註，請使用以下命令：

mcp todoist add-note --task-id ID --content "您的備註內容"

例如：

mcp todoist add-note --task-id 12345678 --content "請記得帶上傘"

🛠️ 開發指南

安裝開發環境

要參與 MCP-Todoist 的開發，請按照以下步驟配置：

# 克隆倉庫
git clone https://github.com/yourusername/mcp-todoist.git
cd mcp-todoist

# 創建虛擬環境（推薦）
python -m venv env
source env/bin/activate  # 在 Windows 上使用 `env\Scripts\activate`

# 安裝依賴項
pip install -r requirements.txt

貢獻指南

如果您希望為 MCP-Todoist 做貢獻，請遵循以下步驟：

1. 報告問題：在 GitHub Issues 頁面上報告您遇到的任何問題或改進建議。
2. 創建功能請求：如果某個功能尚未實現，請在 Feature Requests 頁面上提出。
3. 提交代碼更改：

# 為您的更改創建分支
git checkout -b feature/new-feature-name

# 提交您的更改並推送到遠程倉庫
git add .
git commit -m "描述您所做的更改"
git push origin feature/new-feature-name

創建一個 Pull Request 到 main 分支。

使用 Git Hooks

為了確保代碼質量，建議在項目中配置以下 Git Hooks：

1. 預提交鉤（Pre-Commit Hook）： 在項目根目錄下的 .git/hooks/pre-commit 文件中添加以下內容以自動檢查代碼格式：

#!/bin/bash
flake8 --check .
black --check .

2. 分支命名規範： 請遵循以下分支命名規範：

• 新功能：feature/< 功能名稱 >
• 修復問題：bugfix/< 問題 ID >
• 熱修復：hotfix/< 版本號 >

使用 CI/CD

項目已集成 GitHub Actions 進行自動化測試和構建。每次提交代碼後，CI/CD 流程會自動執行以下操作：

# 運行單元測試
pytest tests/

# 檢查代碼格式
black --check .
flake8 .

構建和發佈包（僅在 main 分支）。

🔗 資源鏈接

• Todoist 官方文檔
• MCP-Todoist 項目倉庫
• 項目貢獻者名單

❓ 問題排查

常見問題解答

1. 如何獲取 Todoist API Token？ 登錄 Todoist 賬戶，進入設置頁面，找到 API 部分，點擊 "Generate New Token" 按鈕。
2. 無法連接到 Todoist 服務怎麼辦？

• 確保您的 API Token 正確無誤。
• 檢查網絡連接是否正常。
• 嘗試在 Todoist 網站上執行相同操作，確認問題是否依然存在。

3. 如何更新 MCP-Todoist 到最新版本？

pip install --upgrade mcp-todoist

📚 開發資源

第三方依賴項

• click：用於命令行接口開發。
• todoist-api-python：用於與 Todoist API 交互。

貢獻者

感謝以下人員對 MCP-Todoist 的貢獻：

• Your Name
• Contributor 1
• Contributor 2

📄 許可證

MCP-Todoist 項目遵循 MIT License。