Todo MCP Server

Todo MCP 服务

一个使用 MCP（Model Context Protocol）服务构建的简易 Todo 应用，用于测试和演示 MCP 交互。

概览

此仓库包含一个以 MCP 服务实现的极简 Todo 应用。它支持：

• 列出所有待办事项
• 查看指定待办事项
• 添加新的待办事项
• 移除待办事项
• 清除所有待办事项
• 创建包含元数据的结构化待办任务

本项目可作为与 Model Context Protocol 服务交互的测试环境，并帮助了解如何通过 MCP 协议构建和公开功能。如需了解更多关于 Model Context Protocol 的信息，请访问 modelcontextprotocol.io。

要求

• 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 Inspector 测试此服务，可以使用：

mcp dev server.py

这将启动服务以及 MCP Inspector 界面，方便测试和调试。

API 用法

此服务公开以下 MCP 资源和工具：

资源

1. 列出所有待办事项：

GET todo://list

2. 查看指定待办事项：

GET todo://view/{item_idx}

其中，item_idx 是你要查看的待办事项索引。

提示词

1. 创建结构化待办任务：

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

此提示词有助于为待办任务添加优先级和截止日期。参数：

• task_name：任务名称／说明
• priority：任务优先级（low、medium、high）
• due_date：任务截止日期（可选）

工具

1. 添加新的待办事项：

add_todo(value: str)

2. 移除待办事项：

remove_todo(item_idx: int)

3. 清除所有待办事项：

clear_todo()

手动添加到 MCP 配置

如果你希望手动将服务添加到 MCP 配置中，可以将以下 JSON 添加到 Claude 桌面配置文件中（在 Mac/Linux 上通常位于 ~/.claude-desktop/claude_desktop_config.json，在 Windows 上通常位于 C:\Users\YourUsername\AppData\Roaming\Claude\claude_desktop_config.json）：

{
  "mcpServers": {
    "todo": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "mcp[cli]",
        "mcp",
        "run",
        "/path/to/your/server.py"
      ]
    }
  }
}

将 /path/to/your/server.py 替换为 server.py 文件的绝对路径。请确保使用绝对路径，而非相对路径。

使用 Docker

你也可以使用 Docker 运行此 MCP 服务，无需在本地安装任何内容。将以下内容添加到 Claude 桌面配置中：

{
  "mcpServers": {
    "todo": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "idsulik/todo-mcp-server"
      ]
    }
  }
}

如果 Docker 镜像尚未存在于你的系统中，它会自动从 Docker Hub 拉取。

贡献

欢迎贡献！请随时提交 Pull Request。