Todo Md MCP

🚀 Todo Markdown MCP Server

このサーバーは、シンプルなMarkdownファイルをバックエンドとするTODOリスト機能を提供するMCP（Model Context Protocol）サーバーです。AIアシスタントが標準化されたMarkdown形式でTODO項目を管理できるようになります。

🚀 クイックスタート

このサーバーは、シンプルなMarkdownファイルを使用してTODOリスト機能を提供するMCPサーバーです。AIアシスタントが標準化されたMarkdown形式でTODO項目を管理できます。

✨ 主な機能

• Markdownベースの保存: TODOは標準的なチェックボックス構文を使用して、シンプルなtodo.mdファイルに保存されます。
• 完全なCRUD操作: TODO項目の作成、読み取り、更新、削除が可能です。
• 永続的なID: 各TODOには信頼性の高い更新のための一意の識別子があります。
• MCP準拠: モデルコンテキストプロトコルの仕様に準拠しています。
• TypeScript: 包括的なエラーハンドリングを備えた完全に型付けされた実装です。
• テスト: Vitestを使用した完全なテストスイートが用意されています。

📦 インストール

NPMからのインストール

npm install -g @danjdewhurst/todo-md-mcp

ローカル開発用のインストール

1. このリポジトリをクローンします:

   git clone https://github.com/danjdewhurst/todo-md-mcp.git
   cd todo-md-mcp
   

2. 依存関係をインストールします:

   npm install
   

3. プロジェクトをビルドします:

   npm run build
   

💻 使用例

Claude Desktopでの使用

このサーバーをClaude Desktopの設定に追加します:

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

または、NPMを通じてグローバルにインストールした場合は:

{
  "mcpServers": {
    "todo-md": {
      "command": "npx",
      "args": ["@danjdewhurst/todo-md-mcp"]
    }
  }
}

TODOファイルの場所を設定する

デフォルトでは、サーバーは現在の作業ディレクトリにtodo.mdファイルを作成します。Claude Desktopを使用する場合、これは書き込み権限のないシステムディレクトリになる可能性があります。TODOファイルのカスタム場所を指定するには、TODO_FILE_PATH環境変数を使用します:

{
  "mcpServers": {
    "todo-md": {
      "command": "npx",
      "args": ["@danjdewhurst/todo-md-mcp"],
      "env": {
        "TODO_FILE_PATH": "/Users/yourname/Documents/todo.md"
      }
    }
  }
}

これにより、TODOファイルが書き込み権限のある場所に作成されるため、一般的な「読み取り専用のファイルシステム」エラーが解消されます。

推奨場所:

• ~/Documents/todo.md - ドキュメントフォルダ
• ~/Desktop/todo.md - デスクトップ
• /path/to/your/project/todo.md - 特定のプロジェクト内

重要: 指定した場所のディレクトリが存在し、書き込み権限があることを確認してください。

利用可能なツール

サーバーは以下のMCPツールを提供します:

list_todos

MarkdownファイルからすべてのTODO項目をリストします。

パラメータ: なし

戻り値: TODO配列と要約統計情報を含むJSONオブジェクト

add_todo

新しいTODO項目を追加します。

パラメータ:

• text (文字列、必須): TODO項目のテキスト

戻り値: 生成されたID付きの作成されたTODO項目

update_todo

既存のTODO項目を更新します。

パラメータ:

• id (文字列、必須): TODO項目のID
• text (文字列、オプション): TODOの新しいテキスト
• completed (ブール値、オプション): 完了/未完了としてマークする

戻り値: 更新されたTODO項目

delete_todo

TODO項目を削除します。

パラメータ:

• id (文字列、必須): 削除するTODO項目のID

戻り値: 成功確認

clear_completed

すべての完了したTODO項目を削除します。

パラメータ: なし

戻り値: 削除された項目の数

📚 ドキュメント

ファイル形式

サーバーは、プロジェクトのルートに以下の形式のtodo.mdファイルを管理します:

# Todo List

- [ ] First incomplete task <!-- id:550e8400-e29b-41d4-a716-446655440000 -->
- [x] Completed task <!-- id:6ba7b810-9dad-11d1-80b4-00c04fd430c8 -->
- [ ] Another task <!-- id:6ba7b811-9dad-11d1-80b4-00c04fd430c8 -->

<!-- Generated by MCP Todo Server -->

各TODO項目には以下が含まれます:

• 標準的なMarkdownチェックボックス構文 (- [ ] または - [x])
• TODOのテキスト
• 追跡用の一意のIDを含む隠しHTMLコメント

開発

スクリプト

• npm run build - TypeScriptプロジェクトをビルドします
• npm run dev - サーバーをビルドして実行します
• npm run watch - 変更を監視して再ビルドします
• npm test - テストスイートを実行します
• npm run test:watch - ウォッチモードでテストを実行します
• npm run lint - ESLintを実行します
• npm run format - Prettierでコードをフォーマットします

テスト

このプロジェクトには、すべての機能をカバーする包括的なテストが含まれています:

npm test

テストは以下をカバーしています:

• Markdownの解析と生成
• CRUD操作
• エラーハンドリング
• ファイル管理

プロジェクト構造

todo-md-mcp/
├── src/
│   ├── index.ts              # メインのMCPサーバー実装
│   ├── todoManager.ts        # TODOのCRUD操作とMarkdown解析
│   └── types.ts              # TypeScriptの型定義
├── tests/
│   └── todoManager.test.ts   # テストスイート
├── dist/                     # ビルドされたJavaScriptファイル
├── package.json
├── tsconfig.json
├── .eslintrc.json
├── .prettierrc
├── vitest.config.ts
└── README.md

必要条件

• Node.js 18以上
• MCP互換のクライアント（Claude Desktopなど）

📄 ライセンス

MIT

🔧 コントリビューション

1. リポジトリをフォークします
2. 機能ブランチを作成します
3. 変更を加えます
4. 新しい機能に対するテストを追加します
5. テストスイートを実行します
6. プルリクエストを送信します

モデルコンテキストプロトコル

このサーバーは、モデルコンテキストプロトコル（MCP）を実装しています。これは、アプリケーションが大規模言語モデルにコンテキストを提供する方法を標準化するオープンプロトコルです。MCPにより、ローカルおよびリモートリソースへの安全で制御されたアクセスが可能になります。

MCPの詳細については、公式ドキュメントを参照してください。