使用说明
Checkvist MCP服务器
用于Checkvist API集成的MCP服务器,使Claude能够读取和写入Checkvist检查表。
特性
- 完成清单CRUD操作(列表、获取、创建、更新、删除)
- 完成任务管理(创建、更新、关闭、重新打开、删除、无效)
- 重复任务配置
- 向用户分配任务
- 一次导入多个任务
- 完成笔记/评论管理(获取、创建、更新、删除)
- 用户资料信息
- 完全支持Checkvist的智能语法(^截止日期、#标签、!优先级)
- 带有可操作提示的有用错误消息
安装
npm install
npm run build
配置
- 从您的个人资料页面获取Checkvist API密钥:https://checkvist.com/auth/profile
- 创建一个
.env文件:
cp .env.example .env
- 编辑
.env并添加您的凭据:
CHECKVIST_USERNAME=your_email@example.com
CHECKVIST_API_KEY=your_api_key_here
Claude桌面配置
添加到您的Claude桌面配置(~/Library/Application Support/Claude/claude_desktop_config.json 在macOS上):
{
"mcpServers": {
"checkvist": {
"command": "node",
"args": [
"/Users/matsingerdal/Developer/GitHub/checkvist-mcp/dist/index.js"
]
}
}
}
可用工具
检查表管理
checkvist_list_checklists-获取所有检查表(只读)checkvist_get_checklist-获取特定检查表信息(只读)checkvist_create_checklist-创建新的检查表checkvist_update_checklist-更新检查表名称或可见性checkvist_delete_checklist-删除检查表(删除标记)
任务管理
checkvist_get_tasks-以原始JSON格式获取所有任务(只读)checkvist_get_tasks_summary-以可读文本格式获取所有任务(只读)checkvist_get_tasks_paginated-在页面中获取任务,以阅读整个大型清单(推荐,只读)checkvist_get_task-以JSON格式获取具有父层次结构的特定任务(只读)checkvist_get_task_tree-以可读文本(只读)获取特定任务及其所有子任务checkvist_create_task-创建新任务(支持assignee_ids)checkvist_update_task-更新现有任务(支持assignee_ids)checkvist_close_task-将任务标记为已完成checkvist_reopen_task-重新打开已完成的任务checkvist_delete_task-删除任务和子任务checkvist_invalidate_task-将任务标记为无效(状态=2)checkvist_set_repeating_task-配置重复任务计划checkvist_import_tasks-一次导入多个任务
注释/评论
checkvist_get_notes-获取任务的所有笔记(只读)checkvist_create_note-向任务添加注释checkvist_update_note-更新现有注释checkvist_delete_note-删除注释
用户信息
checkvist_get_current_user-获取经过身份验证的用户配置文件(只读)
阅读大型清单
对于包含许多任务的大型清单,请根据清单大小使用正确的方法:
策略1:快速预览(最适合非常大的清单)⭐
checkvist_get_tasks_summary 随着 preview: true
- 节目 仅顶级任务 (无子任务)
- 数据最少,非常适合大型清单(1000多个任务)
- 自动使用紧凑模式
- 快速浏览,然后使用Get_task_tree深入查看
- 例子:
checkvist_get_tasks_summary( checklist_id: 941803, preview: true ) - 输出:
📋 Checklist Summary (5 top-level tasks, 847 total) ⚡ PREVIEW MODE: Showing only top-level tasks [ ] Main Project [12345] [ ] Archive [12350] [ ] Notes [12351] [ ] Resources [12352] [ ] Templates [12353] 💡 TIP: Use checkvist_get_task_tree with a specific task ID to explore subtasks
策略2:见完整结构(中型/大型检查表)
checkvist_get_tasks_summary 随着 compact: true
- 节目 完整检查表 超紧凑格式
- 仅显示:状态、标题和ID(无元数据,无注释)
- 可处理数百项任务
- 例子:
checkvist_get_tasks_summary( checklist_id: 941803, compact: true, max_depth: 2 )
策略3:探索特定分支
checkvist_get_task_tree (查看一个分支的详细视图)
- 获取一个特定任务及其所有子任务的完整详细信息
- 显示元数据、注释、截止日期、优先级、标签
- 当您在紧凑视图中找到有趣的任务时,这是完美的
- 例子:
checkvist_get_task_tree(checklist_id: 941803, task_id: 71218558)
策略4:小清单的完整细节
checkvist_get_tasks_summary 随着 compact: false (默认)
- 显示所有包含完整元数据和注释的内容
- 仅适用于任务数少于50的清单
- 对于更大的清单来说,可能太大了
checkvist_get_tasks
- 返回原始JSON结构
- 可能存储在更难读取的文件中
- 仅在需要以编程方式处理JSON时使用
推荐工作流程
选项1:在页面中阅读所有内容 ⭐ (最适合阅读整个清单)
1. checkvist_get_tasks_paginated(checklist_id: X, page: 1)
→ Shows first 3 top-level tasks with ALL their subtasks
2. checkvist_get_tasks_paginated(checklist_id: X, page: 2)
→ Shows next 3 top-level tasks with ALL their subtasks
3. Continue until you've read all pages
克劳德可以用这种方式阅读所有任务,而不会达到大小限制!
选项2:预览+深入查看 (查找特定信息更快)
1. checkvist_get_tasks_summary(checklist_id: X, preview: true)
→ See all top-level tasks (just 5-10 items)
2. Find interesting task in the preview
3. checkvist_get_task_tree(checklist_id: X, task_id: Y)
→ Get all details for that specific branch
智能语法支持
Checkvist支持任务内容中的智能语法:
^tomorrow-设定到期日#tag-添加标签!3-设置优先级(0-9)@username-分配给用户
启用解析 parse_tasks: true 或 parse: true 参数。
发展
# Watch mode
npm run dev
# Build
npm run build
# Start
npm start
API文档
完整的Checkvist API文档:https://checkvist.com/auth/api
