Ticktick Mcpserver

🚀 TicTick MCP Server

This is an implementation of the Model Context Protocol (MCP) server for TickTick, a popular to - do list management application. This server enables AI assistants to interact with TickTick via the TickTick Open API.

✨ Features

• Retrieve tasks from projects.
• Create new tasks (specify due date, priority, and description).
• Update existing tasks.
• Mark tasks as completed.
• Delete tasks.
• Get a list of all projects.
• Create new projects with custom attributes.

🚀 Quick Start

Prerequisites

• Node.js (v18 or higher).
• A TickTick developer account.
• A TickTick API access token.

Installation

1. Clone this repository:

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

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Set environment variables (replace your_access_token_here with your access token):

   export TICKTICK_ACCESS_TOKEN=your_access_token_here
   

5. Run the server.

📌 Authentication Setup

To use the TickTick API, authentication is required. Here is a brief overview of the OAuth2 flow:

1. Obtain the authorization URL and redirect the user.
2. After the user logs in, TickTick will return an authorization code.
3. Use the authorization code to get an access token.

🛠️ Available Tools

Create a New Project

{
  "name": "New Project Name",
  "color": "#F18181", // Optional: Color code
  "view_mode": "list", // Optional: View mode ("list", "kanban", "timeline")
  "kind": "TASK" // Optional: Project type ("TASK", "NOTE")
}

Update an Existing Project

{
  "name": "Updated Project Name",
  "color": "#F18181"
}

📁 Project Structure

ticktick-mcpserver/
├── dist/                     # Compiled TypeScript files (generated after build)
├── src/
│   └── index.ts              # Main server implementation file
├── package.json              # Project dependencies and scripts
├── tsconfig.json             # TypeScript configuration file
└── README.md                 # Documentation

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📚 API Reference

This project uses the TickTick Open API. For detailed information, refer to the official documentation.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Thanks

Thanks to the following projects for their contributions:

• TickTick for providing the API.
• Model Context Protocol (MCP) for providing the protocol specification.