Teamwork MCP

Teamwork MCP

site icon
2025.04.14 4
TypeScript项目管理任务管理团队协作交流协作
Teamwork-MCP 是一个连接 Teamwork API 的 MCP 服务器,提供简化的接口用于与 Teamwork 项目和任务进行交互。它支持通过 RESTful API 端点进行项目的创建、更新和删除,以及任务的检索和管理。此外,它还提供了错误处理和日志记录功能,便于集成到 Cursor 和其他应用程序中。
View on GitHub

Overview

基本能力

产品定位

Teamwork-MCP 是一个中间件服务,旨在简化与 Teamwork 项目管理平台的交互,提供一套工具和 API 接口,方便开发者集成和管理 Teamwork 中的项目和任务。

核心功能

  • 连接 Teamwork API
  • 检索和管理项目及任务
  • 创建、更新和删除任务
  • 提供 RESTful API 端点
  • 错误处理和日志记录
  • 支持 MCP 服务器集成

适用场景

  • 团队项目管理
  • 任务自动化管理
  • 项目报告生成
  • 时间跟踪和分配

工具列表

项目工具

  • getProjects: 获取所有项目
  • getCurrentProject: 获取当前项目详情
  • createProject: 创建新项目

任务工具

  • getTasks: 获取所有任务
  • getTasksByProjectId: 获取特定项目的任务
  • getTaskListsByProjectId: 获取特定项目的任务列表
  • getTaskById: 通过 ID 获取特定任务
  • createTask: 创建新任务
  • createSubTask: 创建子任务
  • updateTask: 更新任务
  • deleteTask: 删除任务
  • getTasksMetricsComplete: 获取已完成任务数
  • getTasksMetricsLate: 获取逾期任务数
  • getTaskSubtasks: 获取任务的子任务
  • getTaskComments: 获取任务的评论

人员工具

  • getPeople: 获取所有人员
  • getPersonById: 通过 ID 获取特定人员
  • getProjectPeople: 获取项目成员
  • addPeopleToProject: 添加人员到项目
  • deletePerson: 删除人员
  • getProjectsPeopleMetricsPerformance: 获取人员绩效指标
  • getProjectsPeopleUtilization: 获取人员利用率
  • getProjectPerson: 获取项目中的特定人员

报告工具

  • getProjectsReportingUserTaskCompletion: 获取用户任务完成报告
  • getProjectsReportingUtilization: 获取利用率报告

时间工具

  • getTime: 获取所有时间记录
  • getProjectsAllocationsTime: 获取项目分配时间

常见问题解答

  • 如何设置 Teamwork 凭证?可以通过环境变量、.env 文件或命令行参数设置。
  • 如何控制可用的工具?使用 --allow-tools--deny-tools 参数进行过滤。
  • 如何关联 Teamwork 项目?创建 .teamwork 文件并设置 PROJECT_ID

使用教程

使用依赖

  • Node.js (v14.17 或更高版本,推荐 18+ 或最新 LTS 版本)
  • npm 或 yarn
  • 具有 API 访问权限的 Teamwork 账户

安装教程

  1. 克隆仓库: bash git clone https://github.com/readingdancer/teamwork-mcp.git cd teamwork-mcp
  2. 安装依赖: bash npm install
  3. 创建 .env 文件: bash cp .env.example .env
  4. 更新 .env 文件中的 Teamwork 凭证。

调试方式

  1. 运行 MCP 服务器: bash node build/index.js
  2. 使用 MCP 检查器进行调试: bash npm run inspector
  3. 通过 Cursor 集成:
  4. 在 Cursor 设置中添加 MCP 服务器,选择 "stdio" 传输类型,并输入运行命令。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。