mcp-ticktick

🚀 咔嗒鱼 MCP 服务器

这是一个专为 TickTick 打造的 模型上下文协议 (MCP) 服务器。借助该服务器，您能够通过 Claude 以及其他 MCP 客户端，直接与 TickTick 任务管理系统进行交互，极大提升任务管理的便捷性。

🚀 快速开始

在运行本项目之前，请确保您已经安装了以下软件和工具：

• Python 3.8 或更高版本
• pip（Python 包管理器）

✨ 主要特性

• 📋 查看所有 TickTick 项目和任务
• ✏️ 通过自然语言创建新项目和任务
• 🔄 更新现有任务详情（标题、内容、日期、优先级）
• ✅ 标记任务为完成
• 🗑 删除任务
• 🔧 创建新项目
• 🗙 删除项目

📦 安装指南

1. 下载并解压项目文件夹。
2. 在项目根目录中，创建一个 config 文件夹，并在其中放置您的 TickTick API 密钥 (app_key) 和密钥 (app_secret)。
3. 打开终端或命令提示符，导航到项目根目录。
4. 运行以下命令安装所有依赖项：

pip install -r requirements.txt

5. 启动服务器：

python ticktick_mcp/ticktick_client.py

📚 详细文档

认证流程

1. 启动服务器后，您将被重定向到 TickTick 的授权页面。
2. 登录您的 TickTick 账户并授予必要的权限。
3. 复制生成的授权码并粘贴回服务器提示的位置。

使用说明

示例命令

# 显示所有项目
curl http://localhost:5000/projects

# 创建新任务
curl -X POST -H "Content-Type: application/json" -d '{"title":"完成 MCP 服务器文档","project_id":"your_project_id","priority":"high"}' http://localhost:5000/tasks

# 标记任务为完成
curl -X PUT -H "Content-Type: application/json" -d '{"project_id":"your_project_id", "task_id":"task_id"}' http://localhost:5000/complete_task

# 删除项目
curl -X DELETE -H "Content-Type: application/json" -d '{"project_id":"your_project_id"}' http://localhost:5000/delete_project

开发指南

项目结构

ticktick-mcp/
├── .env.template          # 环境变量模板
├── README.md              # 项目文档
├── requirements.txt       # 项目依赖
├── setup.py               # 包设置文件
├── test_server.py         # 测试脚本
└── ticktick_mcp/          # 主程序包
    ├── __init__.py        # 包初始化
    ├── authenticate.py    # OAuth 认证工具
    ├── cli.py             # 命令行接口
    └── src/               # 源代码
        ├── __init__.py    # 模块初始化
        ├── auth.py        # OAuth 认证实现
        ├── server.py      # MCP 服务器实现
        └── ticktick_client.py  # TickTick API 客户端

贡献指南

欢迎贡献！请按照以下步骤提交拉取请求：

1. 叉取仓库
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 提交拉取请求

📄 许可证

本项目在 MIT 许可证下发布，详情请参阅 LICENSE 文件。