Ticktick MCP Server

🚀 TickTick MCP Server

This is an MCP (Multi-functional Control Processor) server designed to interact with the TickTick application. It enables the automation and management of TickTick tasks, reminders, and other features via the command line or other integration methods.

🚀 Quick Start

Prerequisites

Ensure that Node.js and npm are installed on your system. You can install them using the following commands:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
source ~/.bashrc
nvm install --lts

Installation

Install the TickTick MCP server globally using npm:

npm install -g @alexarevalo.ai/mcp-server-ticktick

Starting the Server

Start the MCP server with the following command:

npx @alexarevalo.ai/mcp-server-ticktick start

✨ Features

Task and Reminder Management

• Create Tasks: Add new tasks or reminders via REST or RPC interfaces.
• Update Tasks: Modify the status, priority, or other attributes of existing tasks.
• Delete Tasks: Remove tasks by specifying their task IDs.
• Query Tasks: Search for specific tasks or categorize them by tags.

Time Zone and Calendar Integration

• Support multiple time zones to ensure accurate time synchronization for global users.
• Integrate with Google Calendar and other third-party calendar services.

Batch Operations

• Create, update, or delete multiple tasks in batches.
• Export data in CSV or JSON format for further processing.

📦 Installation

Step 1: Install Dependencies

Ensure Node.js and npm are installed:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
source ~/.bashrc
nvm install --lts
npm install -g @alexarevalo.ai/mcp-server-ticktick

Step 2: Run the MCP Server

Start the server with the following command:

npx @alexarevalo.ai/mcp-server-ticktick start

💻 Usage Examples

Configuration in Claude Desktop

Configure the TickTick MCP server in Claude Desktop:

{
  "mcpServers": [
    {
      "name": "ticktick-mcp",
      "type": "custom",
      "host": "localhost",
      "port": "3000",
      "protocol": "http"
    }
  ]
}

📚 Documentation

Configuration

Environment Variables

Create a .env file and add the following content:

TICKTICK_CLIENT_ID=your_client_id
TICKTICK_CLIENT_SECRET=your_client_secret
TICKTICK_ACCESS_TOKEN=your_access_token

First-time Authorization

When running the server for the first time, you need to complete the authorization process:

1. The MCP server will open your browser and redirect you to the TickTick login page.
2. Log in with your TickTick account.
3. Grant the necessary permissions to the application.
4. The generated access token will be displayed in the browser. Copy it and set it as the environment variable TICKTICK_ACCESS_TOKEN.

TickTick Developer Console

Access the Developer Portal

You can access the TickTick developer console via the following link: https://developer.ticktick.com/manage.

Create an Application and Obtain Credentials

1. After logging in, navigate to the "Application Management" page.
2. Click "Create New Application".
3. Fill in the application information and submit it.
4. Find the CLIENT_ID and CLIENT_SECRET on the application details page.

Frequently Asked Questions

How to Generate a New Access Token?

1. In the TickTick developer console, go to the "Credentials" page.
2. Click "Generate New Token".
3. Follow the prompts to complete the verification process and obtain a new access token.

What if the Server Fails to Start?

• Check if the environment variables are correctly configured.
• Ensure that your network connection is stable.
• Check the console output for error messages.

🔧 Technical Details

Security Considerations

• Add the .env file to .gitignore to prevent sensitive information from being committed to the version control system.
• Regularly update access tokens to reduce security risks.

License

This MCP server is distributed under the MIT License. This means you are free to use, modify, and distribute the software, but you must comply with the terms of the MIT License. For more details, please refer to the LICENSE file in the project repository.

📄 License

This project is licensed under the MIT License.