Todo List MCP

🚀 待辦事項 MCP 服務器

這是一個基於 Model Context Protocol (MCP) 的服務器，它提供了全面的 API 來管理待辦事項，能有效提升待辦事項管理的效率和便捷性。

🚀 快速開始

此 MCP 服務器可助力你高效管理待辦事項。以下是快速上手的步驟：

安裝

# 克隆倉庫
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 設置” -> “MCP”
• 添加一個新的 MCP 服務器，類型為“命令行”
• 添加服務器的絕對路徑並使用 Node 運行
• 示例：node /absolute/path/to/todo-list-mcp/dist/index.js

示例命令

與 Claude for Desktop 或 Cursor 結合使用時，可以嘗試以下命令：

• “創建一個待辦事項以學習 MCP，並添加描述說明為什麼 MCP 有用”
• “列出我所有的活躍待辦事項”
• “為明天的會議創建一個待辦事項，並在 Markdown 格式中包含議程細節”
• “將我的學習 MCP 待辦事項標記為已完成”
• “總結所有我的活躍待辦事項”

✨ 主要特性

• 創建待辦事項：可添加新任務，任務包含標題和 Markdown 格式的描述。
• 更新待辦事項：能對現有任務進行修改。
• 完成待辦事項：可將任務標記為已完成。
• 刪除待辦事項：可從列表中移除任務。
• 搜索待辦事項：能按標題或創建日期查找任務。
• 總結待辦事項：可獲取所有活躍任務的快速概覽。

📦 安裝指南

# 克隆倉庫
git clone https://github.com/RegiByte/todo-list-mcp.git
cd todo-list-mcp

# 安裝依賴
npm install

# 構建項目
npm run build

💻 使用示例

基礎用法

啟動服務器：

npm start

高級用法

在不同的應用中配置使用該服務器：

Claude Desktop

將以下內容添加到 claude_desktop_config.json：

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

Cursor

• 轉到“Cursor 設置” -> “MCP”
• 添加一個新的 MCP 服務器，類型為“命令行”
• 添加服務器的絕對路徑並使用 Node 運行
• 示例：node /absolute/path/to/todo-list-mcp/dist/index.js

📚 詳細文檔

工具

此 MCP 服務器公開了以下工具：

1. create-todo：創建一個新的待辦事項
2. list-todos：列出所有待辦事項
3. get-todo：根據 ID 獲取特定待辦事項
4. update-todo：更新待辦事項的標題或描述
5. complete-todo：將待辦事項標記為已完成
6. delete-todo：刪除待辦事項
7. search-todos-by-title：按標題搜索待辦事項（不區分大小寫的部分匹配）
8. search-todos-by-date：按創建日期搜索待辦事項（格式：YYYY - MM - DD）
9. list-active-todos：列出所有未完成的待辦事項
10. summarize-active-todos：生成所有活躍（未完成）待辦事項的摘要

項目結構

項目的代碼目錄如下：

• models：包含數據模型和數據庫交互邏輯
• services：提供核心業務功能的實現
• routes：定義 API 路由和端點
• utils：包含輔助函數和其他工具模塊

學習資源

此項目專為教育目的設計，提供了一個學習 MCP 實現的基礎結構。通過閱讀代碼、實驗功能以及探索其工作原理，開發者可以深入理解 MCP 的核心概念和技術。有關項目的詳細信息及其實現方式，請參閱 GUIDE.md。

開發

構建

npm run build

運行

npm start

📄 許可證

此項目遵循 MIT 許可證。