ticktick-mcpserver

🚀 🛠️ TicTick MCP 服务器

这是 TickTick（一款流行的待办事项管理应用）的 Model Context Protocol (MCP) 服务器实现。该服务器使得 AI 助手能够通过 TickTick 开放 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. 设置环境变量（请将 your_access_token_here 换为你的访问令牌）：

   export TICKTICK_ACCESS_TOKEN=your_access_token_here
   

5. 运行服务器。

✨ 主要特性

• 从项目中获取任务
• 创建新任务（可指定截止日期、优先级和描述）
• 更新现有任务
• 标记任务为完成
• 删除任务
• 获取所有项目的列表
• 创建自定义属性的新项目

📌 认证设置

要使用 TickTick API，需要进行身份验证。以下是 OAuth2 流程的简要说明：

1. 获取授权 URL 并重定向用户。
2. 用户登录后，TickTick 会返回一个授权码。
3. 使用授权码获取访问令牌。

💻 使用示例

基础用法

创建新项目

{
  "name": "新建项目名称",
  "color": "#F18181", // 可选：颜色代码
  "view_mode": "list", // 可选：视图模式（"list", "kanban", "timeline"）
  "kind": "TASK" // 可选：项目类型（"TASK", "NOTE"）
}

更新现有项目

{
  "name": "更新后的项目名称",
  "color": "#F18181"
}

📚 详细文档

该项目使用 TickTick 开放 API。有关详细信息，请参阅官方文档。

📦 项目结构

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

🤝 贡献

欢迎贡献！请随意提交 Pull Request。

1. 叉取仓库。
2. 创建功能分支（git checkout -b feature/amazing-feature）。
3. 提交更改（git commit -m '添加神奇的功能'）。
4. 推送到分支（git push origin feature/amazing-feature）。
5. 打开 Pull Request。

📄 许可证

本项目在 MIT License 下许可，详情请见 LICENSE 文件。

🙏 感谢

感谢以下项目的贡献：

• TickTick 提供 API
• 模型上下文协议（MCP） 提供协议规范