使用说明
待办事项列表MCP
Todo列表管理应用程序 微服务 架构,包括:
- 用户界面:前端使用Next.js 16构建
- 服务器:后端Node.js与MCP(模型上下文协议)集成,用于管理Todos
应用程序可以通过以下方式部署 Docker Compose 并支持从命令行或 .env 文件夹。
预览
项目结构
todolist-mcp/
├─ ui/ # Next.js 16 frontend
├─ server/ # Node.js backend with MCP
├─ docker-compose.yml
需求
- Docker&Docker编写
- Node.js 24.x用于本地开发(仅在没有Docker的情况下运行dev时需要)
安装和运行
- 克隆存储库:
git clone https://github.com/dt313/todolist-mcp.git
cd todolist-mcp
- 创建一个
.env文件在server/:
OLLAMA_API_KEY=your_ollama_api_key
PORT=3222
- 创建一个
.env文件在ui/:
NEXT_PUBLIC_API_PORT=3222
NEXT_PUBLIC_API_LOCALHOST=localhost
- 运行本地
cd todolist-mcp
cd server
npm run dev || npm start
cd ui
npm run dev || npm run build && npm start
使用Docker Compose运行
您可以同时运行UI和服务器:
- 在此处获取云API:https://ollama.com/settings/keys
# Pass environment variables via command line
OLLAMA_API_KEY=your_ollama_api_key SERVER_PORT=your_server_port CLIENT_PORT=your_client_port docker compose up --build
如果没有提供,则使用默认值:
- 服务器端口:
3222||your_server_port - UI端口:
3333||your_client_port
特性
MCP(模型上下文协议)
create_todo/add_tododelete_todo by id or by nameupdate_todo by id or by namedelete_many_todoadd_many_todo
REST API
- 基本的CRUD操作:创建、读取、更新、删除待办事项
备注
- MCP允许服务器执行各种Todo操作:
get_todos,add_todo,update_todo,delete_todo,complete_todo,以及批量操作。 - 当通过Docker Compose运行时
OLLAMA_API_KEY环境变量从命令行直接传递到服务器容器。 - UI从获取API端口
NEXT_PUBLIC_API_PORT环境变量。