🚀 MCP-Todoist 项目说明
MCP-Todoist 是一款可与 Todoist 服务进行交互的应用程序。借助该项目，你能够在终端或其他支持 MCP（Multi-Command Processor）的环境中，直接管理任务与项目。
🚀 快速开始
在使用 MCP-Todoist 前，你需要完成安装和配置，以下是详细步骤。
📦 安装指南
要安装 MCP-Todoist，请按以下步骤操作：
# 克隆此仓库到本地
git clone https://github.com/yourusername/mcp-todoist.git
cd mcp-todoist
# 使用 Python 包管理工具 pip 进行安装
pip install .
# 安装完成后，测试 MCP-Todoist 是否正常工作
mcp --help
⚙️ 项目配置
在使用 MCP-Todoist 前，请先完成以下配置：
- 获取 Todoist API 密钥：访问 Todoist 网站，登录账户，然后进入设置页面获取 API 访问令牌。
- 创建配置文件：在项目根目录下创建一个名为
config.json的文件，并添加以下内容：
{
"todoist": {
"token": "your_api_token_here"
}
}
💻 使用示例
基础用法
1. 创建新任务
要创建新的 Todoist 任务，请运行以下命令：
mcp todoist create-task --title "任务标题" [--due-date YYYY-MM-DD]
--title：必填参数，指定任务的标题。--due-date：可选参数，指定任务的截止日期。
例如：
mcp todoist create-task --title "购买杂货" --due-date 2023-10-25
2. 查询任务
要查询 Todoist 中的任务，请使用以下命令：
按项目查询
mcp todoist list-tasks --project "项目名称"
例如：
mcp todoist list-tasks --project 工作
按标签查询
mcp todoist list-tasks --label "标签名"
例如：
mcp todoist list-tasks --label 重要
3. 更新任务状态
要更新任务的完成状态，请运行以下命令：
标记任务为完成
mcp todoist complete-task --task-id ID
例如：
mcp todoist complete-task --task-id 12345678
标记任务为未完成
mcp todoist uncomplete-task --task-id ID
例如：
mcp todoist uncomplete-task --task-id 12345678
4. 添加备注到任务
要向任务添加备注，请使用以下命令：
mcp todoist add-note --task-id ID --content "您的备注内容"
例如：
mcp todoist add-note --task-id 12345678 --content "请记得带上伞"
🛠️ 开发指南
安装开发环境
要参与 MCP-Todoist 的开发，请按照以下步骤配置：
# 克隆仓库
git clone https://github.com/yourusername/mcp-todoist.git
cd mcp-todoist
# 创建虚拟环境（推荐）
python -m venv env
source env/bin/activate # 在 Windows 上使用 `env\Scripts\activate`
# 安装依赖项
pip install -r requirements.txt
贡献指南
如果您希望为 MCP-Todoist 做贡献，请遵循以下步骤：
- 报告问题：在 GitHub Issues 页面上报告您遇到的任何问题或改进建议。
- 创建功能请求：如果某个功能尚未实现，请在 Feature Requests 页面上提出。
- 提交代码更改：
# 为您的更改创建分支
git checkout -b feature/new-feature-name
# 提交您的更改并推送到远程仓库
git add .
git commit -m "描述您所做的更改"
git push origin feature/new-feature-name
创建一个 Pull Request 到 main 分支。
使用 Git Hooks
为了确保代码质量，建议在项目中配置以下 Git Hooks：
- 预提交钩（Pre-Commit Hook）：
在项目根目录下的
.git/hooks/pre-commit文件中添加以下内容以自动检查代码格式：
#!/bin/bash
flake8 --check .
black --check .
- 分支命名规范： 请遵循以下分支命名规范：
- 新功能：
feature/< 功能名称 > - 修复问题：
bugfix/< 问题 ID > - 热修复：
hotfix/< 版本号 >
使用 CI/CD
项目已集成 GitHub Actions 进行自动化测试和构建。每次提交代码后，CI/CD 流程会自动执行以下操作：
# 运行单元测试
pytest tests/
# 检查代码格式
black --check .
flake8 .
构建和发布包（仅在 main 分支）。
🔗 资源链接
❓ 问题排查
常见问题解答
- 如何获取 Todoist API Token？ 登录 Todoist 账户，进入设置页面，找到 API 部分，点击 "Generate New Token" 按钮。
- 无法连接到 Todoist 服务怎么办？
- 确保您的 API Token 正确无误。
- 检查网络连接是否正常。
- 尝试在 Todoist 网站上执行相同操作，确认问题是否依然存在。
- 如何更新 MCP-Todoist 到最新版本？
pip install --upgrade mcp-todoist
📚 开发资源
第三方依赖项
- click：用于命令行接口开发。
- todoist-api-python：用于与 Todoist API 交互。
贡献者
感谢以下人员对 MCP-Todoist 的贡献：
📄 许可证
MCP-Todoist 项目遵循 MIT License。