MCP Todoist

🚀 MCP-Todoist プロジェクト説明

MCP-Todoist は、Todoist サービスとやり取りするためのアプリケーションです。このプロジェクトを使用すると、ターミナルやその他の MCP（Multi-Command Processor）対応環境で直接タスクやプロジェクトを管理できます。

🚀 クイックスタート

MCP-Todoist を使い始めるには、まずインストールと設定を行う必要があります。以下のセクションで詳細を説明します。

✨ 主な機能

• ターミナルや MCP 対応環境でのタスクとプロジェクトの管理
• 新しいタスクの作成、タスクの検索、タスクの状態の更新、タスクへのメモの追加などの操作が可能

📦 インストール

MCP-Todoist をインストールするには、以下の手順に従ってください。

1. このリポジトリをローカルにクローンします。

   git clone https://github.com/yourusername/mcp-todoist.git
   cd mcp-todoist
   

2. Python パッケージ管理ツールの pip を使用してインストールします。

   pip install .
   

3. インストールが完了したら、以下のコマンドを実行して 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 の開発に参加するには、以下の手順で環境を設定してください。

1. リポジトリをクローンします。

   git clone https://github.com/yourusername/mcp-todoist.git
   cd mcp-todoist
   

2. 仮想環境を作成します（推奨）。

   python -m venv env
   source env/bin/activate  # Windows では `env\Scripts\activate` を使用
   

3. 依存関係をインストールします。

   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
     

   • main ブランチへの Pull Request を作成します。

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 プロセスが自動的に以下の操作を実行します。

1. 単体テストを実行する：

   pytest tests/
   

2. コード形式をチェックする：

   black --check .
   flake8 .
   

3. （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 に従っています。