使用说明
时钟化MCP服务器
模型上下文协议(MCP)服务器,提供与Clockify时间跟踪API的全面集成。此服务器通过标准化的界面实现了自动时间输入管理、项目组织、任务跟踪和报告。
想读成故事 Linkedin帖子
快速安装(推荐)
通过NPM安装
npm install -g @ratheesh-aot/clockify-mcp-server
配置Claude Desktop或任何MCP客户端
将此添加到MCP客户端配置中:
{
"mcpServers": {
"clockify": {
"command": "clockify-mcp-server",
"env": {
"CLOCKIFY_API_KEY": "your_clockify_api_key"
}
}
}
}
获取Clockify API密钥
- 登录到 时钟化
- 转到配置文件设置→ API
- 生成或复制API密钥
- 替换
your_clockify_api_key在上述配置中
开始使用
重新启动MCP客户端(Claude Desktop)并开始询问:
- “显示我的Clockify工作区”
- “在项目营销中创建2小时的时间条目”
- “获取本周的时间条目”
特性
核心功能
- 时间录入管理:创建、读取、更新、删除和停止时间条目
- 项目管理:与客户关联的项目的完整CRUD操作
- 任务管理:在项目中创建和管理任务
- 客户管理:按客户组织工作
- 标签管理:使用标签对时间条目进行分类
- 用户和工作区管理:访问用户信息和工作区详细信息
- 高级报告:通过筛选生成详细和摘要报告
关键能力
- 实时跟踪:启动、停止和管理正在进行的时间条目
- 综合过滤:按项目、任务、客户端、标记和日期范围筛选时间条目
- 分页支持:通过适当的分页有效地处理大型数据集
- 灵活的报告:生成多种格式的报告(JSON、PDF、CSV、XLSX)
- 生产准备就绪:错误处理、验证和强大的API交互
替代安装(开发)
如果您更喜欢从源代码构建或为开发做出贡献:
先决条件
- Node.js 18或更高版本
- 使用API访问的Clockify帐户
- Clockify API密钥
手动安装
- 克隆存储库:
git clone https://github.com/ratheesh-aot/clockify-mcp.git
cd clockify-mcp
- 安装依赖项:
npm install
- 构建TypeScript代码:
npm run build
- 配置完整路径:
{
"mcpServers": {
"clockify": {
"command": "node",
"args": ["/full/path/to/clockify-mcp/dist/index.js"],
"env": {
"CLOCKIFY_API_KEY": "your_api_key_here"
}
}
}
}
可用工具
用户和工作区管理
get_current_user:获取当前用户信息get_workspaces:列出所有可访问的工作区get_workspace_users:获取工作区中的所有用户
时间录入管理
create_time_entry:使用可选的项目/任务关联创建新的时间条目get_time_entries:使用全面的筛选选项检索时间条目update_time_entry:修改现有时间条目delete_time_entry:删除时间条目stop_time_entry:停止当前运行的时间条目
项目管理
create_project:与客户关联创建新项目get_projects:列出具有筛选和分页功能的项目get_project:获取详细的项目信息update_project:修改项目详细信息delete_project:删除项目
任务管理
create_task:在项目中创建任务get_tasks:列出具有筛选选项的任务get_task:获取详细的任务信息update_task:修改任务详细信息delete_task:删除任务
客户管理
create_client:创建新客户get_clients:列出具有筛选功能的客户端update_client:修改客户端信息delete_client:删除客户端
标签管理
create_tag:创建新标签进行分类get_tags:列出可用标签update_tag:修改标签详细信息delete_tag:删除标记
报告
get_detailed_report:生成全面的时间跟踪报告get_summary_report:生成具有分组选项的摘要报告
使用示例
创建时间条目
{
"tool": "create_time_entry",
"arguments": {
"workspaceId": "workspace_id",
"description": "Working on feature implementation",
"start": "2024-01-15T09:00:00Z",
"end": "2024-01-15T17:00:00Z",
"projectId": "project_id",
"billable": true
}
}
通过筛选获取时间条目
{
"tool": "get_time_entries",
"arguments": {
"workspaceId": "workspace_id",
"start": "2024-01-01T00:00:00Z",
"end": "2024-01-31T23:59:59Z",
"project": "project_id",
"page": 1,
"pageSize": 100
}
}
创建项目
{
"tool": "create_project",
"arguments": {
"workspaceId": "workspace_id",
"name": "Website Redesign",
"clientId": "client_id",
"billable": true,
"isPublic": false,
"color": "#FF5722"
}
}
故障排除
常见问题
“找不到命令”错误:
# Check if installed correctly
npm list -g @ratheesh-aot/clockify-mcp-server
# Reinstall if needed
npm uninstall -g @ratheesh-aot/clockify-mcp-server
npm install -g @ratheesh-aot/clockify-mcp-server
“无效的API密钥”错误:
- 验证Clockify API密钥是否正确
- 确保API密钥具有正确的权限
- 检查是否有多余的空格或字符
MCP连接问题:
- 重新启动MCP客户端(Claude Desktop)
- 验证JSON配置是否有效
- 检查Node.js是否已安装且可访问
获取帮助
- 问题: GitHub问题
- 文档: Clockify API文档
- MCP协议: 模型上下文协议
贡献
欢迎投稿!请随时提交拉取请求。
许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。
作者
由...创建 拉希什·库马尔
