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. 研究 heavily commented 源代碼以理解實現細節。
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 的工作原理有所幫助！