TickTick MCP 服务器

一个用于 TickTick (流行的任务管理应用程序) 的模型上下文协议 (MCP) 服务器实现。该服务器允许 AI 助手通过 TickTick Open API 与 TickTick 交互。

📋 功能

• 从项目中获取任务
• 创建包含截止日期、优先级和描述等详细信息的新任务
• 更新现有任务
• 将任务标记为完成
• 删除任务
• 获取项目列表
• 创建具有自定义属性的新项目

🚀 快速开始

前提条件

• Node.js (v18 或更高版本)
• TickTick 开发者帐户
• TickTick API 访问令牌

安装

1. 克隆此存储库:

   git clone https://github.com/shidhincr/ticktick-mcpserver.git
   cd ticktick-mcpserver
   

2. 安装依赖项:

   npm install
   

3. 构建项目:

   npm run build
   

4. 使用您的访问令牌设置环境变量:

   export TICKTICK_ACCESS_TOKEN=your_access_token_here
   

5. 启动服务器:

   npm start
   

🔑 身份验证设置

1. 注册 TickTick 开发者帐户

1. 访问 TickTick 开发者中心
2. 创建一个帐户并注册您的应用程序
3. 获取客户端 ID 和客户端密钥

2. 获取访问令牌

按照 OAuth2 流程获取访问令牌:

1. 将用户重定向到 TickTick 授权页面:

   https://ticktick.com/oauth/authorize?scope=tasks:read tasks:write&client_id=YOUR_CLIENT_ID&state=STATE&redirect_uri=YOUR_REDIRECT_URI&response_type=code
   

2. 交换收到的代码以获取访问令牌: 向 https://ticktick.com/oauth/token 发送 POST 请求，包含:

   • Header: 使用您的 client_id 和 client_secret 进行 Basic 身份验证
   • Body (application/x-www-form-urlencoded):
     • code: 收到的授权码
     • grant_type: authorization_code
     • scope: tasks:read tasks:write
     • redirect_uri: 您的重定向 URI

3. 安全地存储收到的访问令牌。

🛠️ 可用工具

该服务器实现了以下用于 AI 交互的工具:

任务管理

1. ticktick_get_tasks - 从特定项目或所有项目获取任务

   {
     project_id?: string; // 可选的项目 ID
     limit?: number;      // 可选的结果限制 (默认: 10)
   }
   

2. ticktick_create_task - 创建一个新任务

   {
     title: string;       // 必需: 任务标题
     content?: string;    // 可选: 任务内容
     desc?: string;       // 可选: 任务描述
     project_id: string;  // 必需: 项目 ID
     due_date?: string;   // 可选: 截止日期 (ISO 格式)
     priority?: number;   // 可选: 优先级 (0, 1, 3, 5)
     is_all_day?: boolean; // 可选: 全天任务标志
   }
   

3. ticktick_update_task - 更新现有任务

   {
     project_id: string;  // 必需: 项目 ID
     task_id: string;     // 必需: 任务 ID
     title?: string;      // 可选: 新标题
     // ... 其他任务属性
   }
   

4. ticktick_complete_task - 将任务标记为完成

   {
     project_id: string;  // 必需: 项目 ID
     task_id: string;     // 必需: 任务 ID
   }
   

5. ticktick_delete_task - 删除任务

   {
     project_id: string;  // 必需: 项目 ID
     task_id: string;     // 必需: 任务 ID
   }
   

项目管理

1. ticktick_get_projects - 获取所有项目列表

2. ticktick_create_project - 创建一个新项目

   {
     name: string;        // 必需: 项目名称
     color?: string;      // 可选: 颜色代码 (例如 "#F18181")
     view_mode?: string;  // 可选: 视图模式 ("list", "kanban", "timeline")
     kind?: string;       // 可选: 项目类型 ("TASK", "NOTE")
   }
   

📁 项目结构

ticktick-mcpserver/
├── dist/                     # 编译后的 TypeScript (构建后生成)
├── src/
│   └── index.ts              # 主要服务器实现
├── package.json              # 项目依赖项和脚本
├── tsconfig.json             # TypeScript 配置
└── README.md                 # 文档

🤝 贡献

欢迎贡献! 请随时提交 Pull Request。

1. Fork 存储库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

📚 API 参考

本项目使用 TickTick Open API。 有关 API 端点和参数的详细信息，请参阅官方文档。

📝 许可证

本项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。

🙏 鸣谢

• TickTick 提供 API
• 模型上下文协议 (MCP) 提供协议规范