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 文件。