Todo List

🚀 待办事项列表 MCP サーバー

このサーバーは、Model Context Protocol (MCP) を利用して、待办事項を包括的に API 管理することができます。

📚 学習リソース

このプロジェクトは、MCP の実装を学ぶための教育的な例として作成されています。詳細な説明については、GUIDE.md を参照してください。ここでは、なぜこのように実装されているのか、そしてどのように動作するのかが解説されています。

✨ 主な機能

• 待办事項の作成：タイトルと Markdown 形式の説明を持つ新しいタスクを追加します。
• 待办事項の更新：既存のタスクを修正します。
• 待办事項の完了：タスクを完了済みとしてマークします。
• 待办事項の削除：タスクリストからタスクを削除します。
• 待办事項の検索：タイトルまたは作成日でタスクを検索します。
• 待办事項の要約：すべての未完了タスクの概要をすばやく確認します。

📦 インストール

# リポジトリをクローンする
git clone https://github.com/RegiByte/todo-list-mcp.git
cd todo-list-mcp

# 依存関係をインストールする
npm install

# プロジェクトをビルドする
npm run build

💻 使用例

サーバーの起動

npm start

Claude for Desktop での設定

Claude Desktop

以下の内容を claude_desktop_config.json に追加します。

{
  "mcpServers": {
    "todo": {
      "command": "node",
      "args": ["/absolute/path/to/todo-list-mcp/dist/index.js"]
    }
  }
}

Cursor

• "Cursor Settings" -> MCP に移動します。
• 新しい MCP サーバーを追加し、タイプを "command" に設定します。
• サーバーの絶対パスを追加し、node で実行します。
• 例：node /absolute/path/to/todo-list-mcp/dist/index.js

サンプルコマンド

Claude for Desktop または Cursor と組み合わせて使用する場合、以下のコマンドを試すことができます。

• "MCP を学ぶための待办事項を作成し、MCP が有用な理由を説明する記述を添付する"
• "すべてのアクティブな待办事項をリストする"
• "明日の会議のために、議事内容の詳細（Markdown 形式）を持つ待办事項を作成する"
• "MCP を学ぶ待办事項を完了済みとしてマークする"
• "すべてのアクティブな待办事項を要約する"

📚 ドキュメント

プロジェクト構造

このプロジェクトは、理解とメンテナンスを容易にするために、明確な階層構造に従っています。

src/
├── models/       # データ構造と検証モデル
├── services/     # ビジネスロジックとサービス操作
├── utils/        # 補助関数とフォーマットツール
├── config.ts     # 設定
├── client.ts     # ローカルテスト用のクライアント
└── index.ts      # エントリーファイル、MCP ツール定義を含む

学習ガイド

このプロジェクトは教育的な例として作成されています。これを最大限に活用するには、以下の手順を実行してください。

1. GUIDE.md を読んで、全体的な設計を理解します。
2. コメントが豊富に付けられたソースコードを研究して、実装の詳細を理解します。
3. クライアントを使用してローカルでテストし、プロジェクトの動作を確認します。
4. 開発手順とサンプルを見て、MCP の使用方法をさらに習得します。

開発手順

# リポジトリをローカルにクローンする
git clone https://github.com/RegiByte/todo-list-mcp.git

# プロジェクトディレクトリに移動する
cd todo-list-mcp

# 依存関係をインストールする
npm install

# 開発サーバーを起動する
npm run dev

📄 ライセンス

このプロジェクトのコードは MIT ライセンスに従っています。詳細については、LICENSE を参照してください。

# ライセンス内容を表示する
cat LICENSE

この MCP プロジェクトを使用することで、待办事項を簡単に管理し、さまざまなアプリケーションに統合することができます。この例が MCP の仕組みを理解するのに役立つことを願っています！