README
🚀 Todo MCP 服务器
这是一个借助模型上下文协议(MCP)构建的简易待办事项应用程序,主要用于 MCP 交互的测试与演示。
🚀 快速开始
此存储库包含一个作为 MCP 服务器实现的最小待办事项应用程序。它允许您执行以下操作:
- 列出所有待办事项
- 查看特定待办事项
- 添加新的待办事项
- 删除待办事项
- 清除所有待办事项
- 创建带元数据的结构化任务
此项目作为一个测试床,用于与模型上下文协议服务器交互并了解如何通过 MCP 协议构建和暴露功能。有关模型上下文协议的更多信息,请访问 modelcontextprotocol.io。
✨ 主要特性
- 支持多种待办事项操作,如查看、添加、删除等。
- 可创建带元数据的结构化任务。
- 能作为测试床与 MCP 服务器交互。
📦 安装指南
先决条件
- Python 3.10 或更高版本
- uv(Python 包安装工具)
安装步骤
- 克隆仓库:
git clone https://github.com/idsulik/todo-mcp-server.git
cd todo-mcp-server
- 使用 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 替换为实际的文件路径。
📚 详细文档
API 使用
该服务器通过以下 MCP 资源和工具公开接口,具体使用方法可参考上面的使用示例部分。
🤝 贡献
欢迎为该项目提交代码合并请求!
Scan to contact