Todo MCP Server

🚀 Todo MCP 服務器

這是一個藉助模型上下文協議（MCP）搭建的簡易待辦事項應用程序，主要用於測試和演示 MCP 交互，為開發者提供一個直觀瞭解 MCP 功能的途徑。

🚀 快速開始

此存儲庫包含一個作為 MCP 服務器實現的最小待辦事項應用程序。它允許您執行以下操作：

• 列出所有待辦事項
• 查看特定待辦事項
• 添加新的待辦事項
• 刪除待辦事項
• 清除所有待辦事項
• 創建帶元數據的結構化任務

此項目作為一個測試床，用於與模型上下文協議服務器交互並瞭解如何通過 MCP 協議構建和暴露功能。有關模型上下文協議的更多信息，請訪問 modelcontextprotocol.io。

✨ 主要特性

• 支持多種待辦事項操作，如列出、查看、添加、刪除、清除等。
• 可創建帶元數據的結構化任務。
• 既可以通過命令行工具添加到 MCP 服務器列表，也支持手動添加到 MCP 配置。
• 支持使用 Docker 運行服務器。

📦 安裝指南

先決條件

• Python 3.10 或更高版本
• uv（Python 包安裝工具）

安裝步驟

1. 克隆倉庫：

git clone https://github.com/idsulik/todo-mcp-server.git
cd todo-mcp-server

2. 使用 uv 安裝依賴項：

uv pip install -e .

添加到 MCP 服務器列表

要將此服務器添加到您的 MCP 服務器列表中，請使用以下命令：

mcp install server.py --name "Todo MCP"

這會將服務器註冊到 Claude 桌面應用程序或其他支持 MCP 的應用程序。

如果需要使用 MCP 檢查器測試服務器，可以使用：

mcp dev server.py

這將啟動服務器，並附帶 MCP 檢查器界面，方便測試和調試。

Docker 安裝

要使用 Docker 運行服務器，請運行以下命令：

docker pull ghcr.io/idsulik/todo-mcp-server:latest
docker run -it ghcr.io/idsulik/todo-mcp-server:latest

💻 使用示例

基礎用法

資源

• 列出所有待辦事項：

GET todo://list

• 查看特定待辦事項：

GET todo://view/{item_idx}

其中 item_idx 是您要查看的待辦事項索引。

提示

創建結構化任務：

create_task(task_name: str, priority: str = "medium", due_date: str = "")

此提示幫助格式化帶有優先級和截止日期的待辦事項任務。參數：

• task_name：任務的名稱/描述
• priority：任務優先級（low、medium、high）
• due_date：任務的截止日期（可選）

工具

• 添加新待辦事項：

add_todo(value: str)

• 刪除待辦事項：

remove_todo(item_idx: int)

• 清除所有待辦事項：

clear_todo()

手動添加到 MCP 配置

如果願意手動將服務器添加到您的 MCP 配置中，可以向 Claude 桌面配置文件添加以下 JSON（通常位於 ~/.claude-desktop/claude_desktop_config.json 或 C:\Users\YourUsername\AppData\Roaming\Claude\claude_desktop_config.json）：

{
  "mcpServers": {
    "todo": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "mcp",
        server.py
      ]
    }
  }
}

請將 server.py 替換為實際的文件路徑。

📚 詳細文檔

該服務器通過 MCP 資源和工具公開接口，涵蓋資源操作、提示使用和工具調用等方面，為用戶提供了豐富的待辦事項管理功能。

📄 許可證

文檔中未提及許可證相關信息。

貢獻

歡迎為該項目提交代碼合併請求！