ticktick-mcp-server-interactive
v1.2.0
Published
Model Context Protocol server for TickTick task management integration with AI assistants like Claude
Maintainers
Readme
@ticktick-ecosystem/mcp-server
A Model Context Protocol (MCP) server for integrating TickTick task management with AI applications like Claude, ChatGPT, and other LLM-powered tools.
✨ Features
🛠️ Tools (AI Actions)
Task Management
create_task- Create new tasks with due dates, priorities, and projectsget_tasks- Retrieve tasks with filtering optionsupdate_task- Modify existing taskscomplete_task- Mark tasks as completeddelete_task- Remove taskssearch_tasks- Search tasks by title or contentget_today_tasks- Get today's scheduled tasksget_overdue_tasks- Get overdue tasks
Project Management
get_projects- List all projectscreate_project- Create new projectsupdate_project- Modify project detailsdelete_project- Remove projectsget_project_tasks- Get tasks within a specific project
📊 Resources (Data Access)
ticktick://tasks/today- Today's tasksticktick://tasks/overdue- Overdue tasksticktick://tasks/completed- Recently completed tasksticktick://projects/all- All projectsticktick://stats/summary- Productivity statistics
💡 Prompts (AI Assistance)
daily_planning- AI-powered daily task planningtask_breakdown- Break complex tasks into subtaskspriority_analysis- Analyze and suggest task prioritiesweekly_review- Review productivity and plan aheadproject_planning- Comprehensive project planning
🚀 Quick Start
Demo Mode (No Authentication Required)
Perfect for testing and evaluation:
# Install and run in demo mode
npm install -g @ticktick-ecosystem/mcp-server
ticktick-mcp-server --demoOr with npx:
npx @ticktick-ecosystem/mcp-server --demoClaude Desktop Integration (Demo Mode)
Add to your Claude Desktop configuration file:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"ticktick": {
"command": "npx",
"args": ["@ticktick-ecosystem/mcp-server", "--demo"],
"env": {
"TICKTICK_DEMO_MODE": "true"
}
}
}
}Restart Claude Desktop and start asking about your tasks!
📦 Installation
npm install @ticktick-ecosystem/mcp-serverOr install globally:
npm install -g @ticktick-ecosystem/mcp-server🔧 Authentication Setup (For Real Data)
1. Get TickTick API Credentials
- Visit TickTick Developer Portal
- Create a new application
- Note your Client ID and Client Secret
- Set OAuth Redirect URL to:
http://localhost:3000/callback
2. Environment Configuration
Create a .env file or set environment variables:
# Required
TICKTICK_CLIENT_ID=your_client_id_here
TICKTICK_CLIENT_SECRET=your_client_secret_here
# Optional (will be obtained through OAuth if not provided)
TICKTICK_REDIRECT_URI=http://localhost:3000/callback
TICKTICK_ACCESS_TOKEN=your_access_token_here
TICKTICK_REFRESH_TOKEN=your_refresh_token_here3. Interactive Setup (Recommended)
# Install the package
npm install -g @ticktick-ecosystem/mcp-server
# Run interactive setup
npx @ticktick-ecosystem/mcp-server --setupThis will guide you through:
- Getting TickTick API credentials
- OAuth authorization flow
- Automatic configuration saving to
~/.ticktick-mcp/config.json
🎯 Usage Examples
Creating Tasks with AI
User: "Create a task to review the quarterly budget report, due next Friday with high priority"
AI Response: "I'll create that task for you with high priority and set the due date for next Friday."
Result: New task created in TickTick with proper priority and due dateDaily Planning
User: "Help me plan my day"
AI Response: Based on your current tasks, I recommend:
1. Morning: Focus on the quarterly budget review (high priority)
2. Afternoon: Team meeting preparation
3. Evening: Code review for the new feature
Would you like me to adjust any task priorities or deadlines?Project Management
User: "Show me all tasks in my 'Website Redesign' project that are overdue"
AI Response: [Lists overdue tasks with details and suggests next actions]🔧 Configuration
Demo Mode Features
- ✅ No authentication required
- ✅ Uses realistic mock data
- ✅ All functions work with sample tasks and projects
- ✅ Perfect for testing and evaluation
- ✅ Safe for public demonstrations
Production Mode Features
- 🔄 Real-time TickTick synchronization
- 🔐 OAuth 2.0 secure authentication
- 📊 Access to your actual tasks and projects
- 🔄 Automatic token refresh
- 📈 Real productivity statistics
Claude Desktop Configuration (Production)
{
"mcpServers": {
"ticktick": {
"command": "npx",
"args": ["@ticktick-ecosystem/mcp-server"],
"env": {
"TICKTICK_CLIENT_ID": "your_client_id",
"TICKTICK_CLIENT_SECRET": "your_client_secret",
"TICKTICK_ACCESS_TOKEN": "your_access_token",
"TICKTICK_REFRESH_TOKEN": "your_refresh_token"
}
}
}
}Other MCP Clients
The server uses stdio transport and is compatible with any MCP-compliant client:
# For MCP Inspector
npx @modelcontextprotocol/inspector npx @ticktick-ecosystem/mcp-server --demo
# For custom integrations
npx @ticktick-ecosystem/mcp-server📊 API Reference
Task Priority Levels
0- None1- Low3- Medium5- High
Date Formats
- Due dates: ISO format (
YYYY-MM-DDorYYYY-MM-DDTHH:mm:ss) - All dates are in UTC unless timezone is specified
Response Format
All tools return structured responses:
Success:
{
"success": true,
"data": { ... },
"message": "Operation completed successfully"
}Error:
{
"success": false,
"error": "Error description"
}🧪 Testing
# Quick demo test
npm run demo
# With MCP Inspector
npm install -g @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector npx @ticktick-ecosystem/mcp-server --demoSee TESTING.md for comprehensive testing instructions.
🔒 Security & Privacy
- OAuth 2.0 secure authentication
- Tokens stored locally only
- No data collection or telemetry
- Open source and auditable
- Demo mode uses no real data
🛠️ Development
# Clone repository
git clone https://github.com/ticktick-ecosystem/mcp-server
cd mcp-server
# Install dependencies
npm install
# Build
npm run build
# Development mode
npm run dev
# Run tests
npm test
# Demo mode
npm run demo📖 Documentation
- Authentication Guide - Detailed authentication setup
- Testing Guide - Comprehensive testing instructions
- MCP Protocol - Learn about Model Context Protocol
- TickTick API - Official TickTick API documentation
🤝 Contributing
We welcome contributions! Please see our contributing guidelines:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🆘 Support
🌟 Related Projects
- Model Context Protocol - The protocol this server implements
- TickTick - The task management platform
- Claude Desktop - AI assistant with MCP support
- MCP Inspector - Tool for testing MCP servers
🙏 Acknowledgments
- Anthropic for developing the Model Context Protocol
- TickTick for providing the task management API
- The MCP community for feedback and contributions
Made with ❤️ for the TickTick and MCP communities
🎉 Ready to supercharge your productivity with AI-powered task management!
