Todo MD MCP

Todo Markdown MCP Server

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

特長

• Markdown ベースのストレージ：標準的なチェックボックス構文を使用し、シンプルな todo.md ファイルに ToDo を保存します
• 完全な CRUD 操作：ToDo 項目の作成、読み取り、更新、削除ができます
• 永続的な ID：各 ToDo に一意の識別子があり、確実に更新できます
• MCP 準拠：Model Context Protocol の仕様に準拠しています
• 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（string、必須）：ToDo 項目のテキスト

戻り値： 生成された ID を含む、作成された ToDo 項目

update_todo

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

パラメーター：

• id（string、必須）：ToDo 項目の ID
• text（string、任意）：ToDo の新しいテキスト
• completed（boolean、任意）：完了／未完了として設定します

戻り値： 更新された ToDo 項目

delete_todo

ToDo 項目を削除します。

パラメーター：

• id（string、必須）：削除する ToDo 項目の ID

戻り値： 成功を示す確認メッセージ

clear_completed

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

パラメーター： なし

戻り値： 削除された項目数

ファイル形式

このサーバーは、次の形式でプロジェクトのルートにある todo.md ファイルを管理します：

# Todo List

- [ ] First incomplete task 
- [x] Completed task 
- [ ] Another task 

各 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              # Main MCP server implementation
│   ├── todoManager.ts        # Todo CRUD operations and markdown parsing
│   └── types.ts              # TypeScript type definitions
├── tests/
│   └── todoManager.test.ts   # Test suite
├── dist/                     # Built JavaScript files
├── 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. プルリクエストを送信します

Model Context Protocol

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

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