使用说明
Todo MCP服务器
使用MCP(模型上下文协议)服务器构建的简单Todo应用程序,用于测试和演示MCP 互动。
概述
此存储库包含一个作为MCP服务器实现的最小Todo应用程序。它允许您:
- 列出所有待办事项
- 查看特定待办事项
- 添加新的所有项目
- 删除待办事项
- 清除所有待办事项
- 使用元数据创建结构化待办事项任务
该项目作为一个测试平台,用于与模型上下文协议服务器交互,并了解如何构建和 通过MCP协议公开功能。关于模型上下文协议的更多信息, 访问 模型上下文协议.io.
需求
- 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 Desktop应用程序或其他启用MCP的应用程序注册服务器。
或者,如果您想使用MCP检查器测试服务器,可以使用:
mcp dev server.py
这将启动服务器以及MCP Inspector界面,以便于测试和调试。
API使用
服务器公开以下MCP资源和工具:
资源
- 列出所有待办事项:
GET todo://list
- 查看特定待办事项:
GET todo://view/{item_idx}
哪里 item_idx 是您要查看的项目的索引。
鼓励
- 创建结构化的todo任务:
create_task(task_name: str, priority: str = "medium", due_date: str = "")
此提示有助于用优先级和截止日期格式化待办任务。参数:
task_name:任务的名称/描述priority:任务优先级(低、中、高)due_date当任务到期(可选)
工具
- 添加新的Todo项目:
add_todo(value: str)
- 删除待办事项:
remove_todo(item_idx: int)
- 清除所有待办事项:
clear_todo()
手动添加到MCP配置
如果您希望手动将服务器添加到MCP配置中,可以将以下JSON添加到Claude中
桌面配置文件(通常位于 ~/.claude-desktop/claude_desktop_config.json 在Mac/Linux或
C:\Users\YourUsername\AppData\Roaming\Claude\claude_desktop_config.json 在Windows上):
{
"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 Desktop配置中:
{
"mcpServers": {
"todo": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"idsulik/todo-mcp-server"
]
}
}
}
如果Docker镜像尚未在您的系统上,它将自动从Docker Hub中拉取。
贡献
欢迎投稿!请随时提交拉取请求。