README
🚀 MCP TODO清单检查服务器
MCP TODO清单检查服务器是一个基于MCP(Model Context Protocol)的任务清单管理系统,专为Claude Desktop的任务管理而设计。它支持创建和管理多个任务清单,具备优先级、截止日期和标签等功能,能有效帮助用户高效管理任务。
🚀 快速开始
MCP TODO清单检查服务器是一款强大的任务管理工具,可帮助您高效管理任务清单。以下是使用该服务器的基本步骤:
- 确保满足安装要求。
- 选择合适的安装方法进行安装。
- 配置
claude_desktop_config.json文件。 - 使用可用命令进行任务清单的创建、读取、更新和删除操作。
✨ 主要特性
- ✅ 创建和管理多个任务清单,方便用户分类管理不同类型的任务。
- 📌 支持优先级(低、中、高)设置,让用户能够根据任务的重要程度进行排序。
- 📅 任务截止日期设置,帮助用户合理安排时间,确保任务按时完成。
- 🏷️ 标签系统用于分类整理,便于用户快速查找和筛选任务。
- 👥 用户间共享任务清单,方便团队协作和信息共享。
- 💾 数据持久化存储在文件系统中,确保数据的安全性和可靠性。
📦 安装指南
安装要求
- Node.js 18或更高版本
- NPM 8或更高版本
安装方法
方法 1:本地安装(开发用途)
- 克隆仓库
cd C:\workspace\mcp
git clone (your-repository) mcp-mr-checklist
cd mcp-mr-checklist
- 安装依赖并构建
npm install
npm run build
- 配置
claude_desktop_config.json:
{
"servers": {
"todo-checklist": {
"type": "command",
"command": "node dist/index.js",
"cwd": "C:\\workspace\\mcp\\mcp-mr-checklist",
"config": {
"storagePath": "./data",
"commandTimeout": 60000
}
}
}
}
方法 2:全局安装(使用用途)
- 全局安装包
npm install -g @hevener/server-todo-checklist
- 配置
claude_desktop_config.json:
{
"servers": {
"todo-checklist": {
"type": "command",
"command": "mcp-server-todo-checklist",
"config": {
"storagePath": "C:\\Users\\YOUR_USER\\AppData\\Local\\claude-todo-checklist",
"commandTimeout": 60000
}
}
}
}
💻 使用示例
基础用法
以下是一些可用命令及其示例:
/todo_create:创建新任务清单
/todo_create {
"name": "工作任务",
"tasks": [
{ "title": "项目报告", "priority": "高", "deadline": "2023-10-31" },
{ "title": "团队会议", "priority": "中", "deadline": "2023-11-01" }
]
}
/todo_read:读取所有任务清单/todo_update:更新现有任务清单/todo_delete:删除指定任务清单
📚 详细文档
项目结构
.
├── src/
│ ├── index.ts # 入口文件
│ └── checklist.ts # 清单管理逻辑
├── schemas/ # 数据验证模式
│ └── checklist.schema.ts # 清单数据模式
└── dist/
└── index.js # 构建输出
配置选项
在claude_desktop_config.json中,您可以配置以下参数:
| 属性 | 详情 |
|------|------|
| storagePath | 存储数据的目录路径 |
| commandTimeout | 命令执行的最大超时时间(默认单位为毫秒,60000) |
🔧 技术细节
本项目使用了以下技术:
- TypeScript:一种强类型的JavaScript超集,提供了更好的代码可读性和可维护性。
- Model Context Protocol SDK:用于实现MCP协议,确保服务器与Claude Desktop之间的通信。
- Zod(数据验证):用于对输入数据进行验证,确保数据的合法性和完整性。
- 基于文件的存储系统:将数据持久化存储在文件系统中,确保数据的安全性和可靠性。
📄 许可证
本项目遵循MIT许可证分发。有关详细信息,请参阅LICENSE文件。
Scan to contact