使用说明

项目简介

TickTick MCP服务器是为TickTick API设计的Model Context Protocol (MCP) 服务器，旨在为大型语言模型 (LLM) 提供结构化的接口，以便它们能够与用户的TickTick账户进行交互。通过此服务器，LLM可以执行诸如创建、读取、更新和删除任务、管理项目以及跟踪习惯等操作。

主要功能点

任务管理: 支持创建、读取、更新和删除TickTick任务，涵盖任务的各种属性，例如标题、内容、优先级、截止日期、提醒和重复规则。
项目管理: 支持创建、读取、更新和删除TickTick项目，包括自定义视图模式（列表、看板、时间线）和项目类型。
子任务支持: 完整支持管理任务中的子任务。
OAuth 认证: 采用OAuth2.0协议进行安全的用户身份验证和授权，确保API访问的安全性。
工具集成: 提供一系列预定义的工具，例如获取任务、创建任务、更新任务、完成任务、删除任务、获取项目列表、获取项目详情等，方便LLM调用。

安装步骤

注册TickTick开发者账号并创建应用:
- 访问 TickTick Developer Portal 注册开发者账号。
- 创建新的应用，并配置OAuth重定向URL为 'http://localhost:8000/callback'。
- 获取应用的 'Client ID' 和 'Client Secret'。

配置环境变量:

复制仓库代码到本地。
在项目根目录下创建 '.env' 文件（如果不存在）。

在 '.env' 文件中添加您的 TickTick 'Client ID' 和 'Client Secret'，例如：

TICKTICK_CLIENT_ID=<YOUR_CLIENT_ID>
TICKTICK_CLIENT_SECRET=<YOUR_CLIENT_SECRET>

运行服务器:

确保您已安装 Node.js 和 npm。
在项目根目录下，打开终端并运行以下命令安装依赖：
```
npm install
```

运行服务器：

npm start

或者使用 npx 直接运行：

npx @modelcontextprotocol/server-ticktick

服务器配置

要将此MCP服务器与MCP客户端（例如 Claude Desktop）连接，您需要在客户端的配置文件中添加服务器配置信息。以下是两种常用的配置方式，您可以根据自己的环境选择：

Docker 方式

如果使用 Docker 运行，请确保已安装 Docker。客户端配置 (例如 'claude_desktop_config.json') 示例如下：

{
  "mcpServers": {
    "ticktick": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "TICKTICK_CLIENT_ID",
        "-e",
        "TICKTICK_CLIENT_SECRET",
        "mcp/ticktick"
      ],
      "env": {
        "TICKTICK_CLIENT_ID": "<YOUR_CLIENT_ID>",
        "TICKTICK_CLIENT_SECRET": "<YOUR_CLIENT_SECRET>"
      }
    }
  }
}

NPX 方式

如果直接使用 NPX 运行，客户端配置示例如下：

{
  "mcpServers": {
    "ticktick": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-ticktick"],
      "env": {
        "TICKTICK_CLIENT_ID": "<YOUR_CLIENT_ID>",
        "TICKTICK_CLIENT_SECRET": "<YOUR_CLIENT_SECRET>"
      }
    }
  }
}

配置参数说明:

'server name': 'ticktick' (服务器名称，客户端用以识别)
'command': 'docker' 或 'npx' (启动服务器的命令)
'args': 启动命令的参数，
- Docker 方式: 'run -i --rm -e TICKTICK_CLIENT_ID -e TICKTICK_CLIENT_SECRET mcp/ticktick' (运行 Docker 镜像，并传递环境变量)
- NPX 方式: '-y @modelcontextprotocol/server-ticktick' (使用 npx 运行 npm 包)
'env': 环境变量配置，
- 'TICKTICK_CLIENT_ID': 您的 TickTick 应用 Client ID
- 'TICKTICK_CLIENT_SECRET': 您的 TickTick 应用 Client Secret

基本使用方法

首次授权: 首次运行服务器或客户端连接服务器时，会自动打开浏览器进行 TickTick OAuth 授权。按照页面提示完成授权流程。授权成功后，访问令牌将自动保存。
LLM 调用工具: 在LLM应用中，配置并连接到 TickTick MCP 服务器后，LLM即可通过调用服务器提供的工具来操作 TickTick。例如，LLM 可以调用 'create_task' 工具来创建一个新的 TickTick 任务，或者调用 'get_project_by_id' 工具来获取项目信息。
查看可用工具: LLM客户端通常可以列出 MCP 服务器提供的工具列表及其描述。您可以参考 'README.md' 文件中 "Tools" 部分查看所有可用的工具及其参数。

注意: 此项目目前处于积极开发阶段，部分功能可能尚未完善或存在变动。请关注项目仓库的更新和文档。

关键词