Teamwork MCP

🚀 团队合作工具 - 团队工作 MCP 服务器

团队工作 MCP 服务器是专为 Teamwork 平台打造的集成模块（MCP），可与 Cursor 等工具交互。借助该 MCP，用户能直接在 Teamwork 上执行各类任务与操作。

🚀 快速开始

本项目是为 Teamwork 平台设计的集成模块，能与其他工具交互，让您在 Teamwork 上轻松完成各种任务。以下为您介绍具体的安装和使用方法。

📦 安装指南

使用 NPX （推荐）

最简便的运行方式是使用 NPX：

npx teamwork-mcp

若需配置选项，可按如下操作：

npx teamwork-mcp --domain=your-company --user=your-email@example.com --pass=your-password

构建应用

若您想自行构建代码，可执行以下命令：

npm run build

此命令会将 TypeScript 代码编译为可直接运行的 MCP 服务器。

作为 MCP 服务器运行

若要以 MCP 服务器形式运行并与其他应用集成，假设您使用 .env 文件或环境变量配置用户名、密码和 URL，可执行：

node C:/your-full-path/build/index.js

也可通过命令行参数传递配置：

node C:/your-full-path/build/index.js --teamwork-domain=your-company --teamwork-username=your-email@example.com --teamwork-password=your-password

还可使用简写形式：

node C:/your-full-path/build/index.js --domain=your-company --user=your-email@example.com --pass=your-password

使用 MCP 检查工具

若要运行 MCP 检查工具进行调试，可执行：

npm run inspector

📚 详细文档

配置 Teamwork 项目

为将当前解决方案与 Teamwork 项目关联，可创建 .teamwork 文件，内容如下：

PROJECT_ID = YourTeamworkProjectID

该配置文件用于标识特定的 Teamwork 项目，未来可能会添加更多详细信息。配置完成后，MCP 就能识别您的 Teamwork 项目，并与当前解决方案关联，减少获取项目和任务所需的 API 调用数量。

使用说明

添加到 Cursor（及其他 MCP 客户端）

• 版本低于 0.47：
  1. 打开 Cursor 设置 > 功能 > MCP。
  2. 点击 "+ 添加新的 MCP 服务器"。
  3. 输入服务器名称（例如："Teamwork API"）。
  4. 选择 "stdio" 作为传输类型。
  5. 在命令字段中输入：npx @vizioz/teamwork-mcp，并添加所需的命令行参数，如域名、用户名和密码。您还可在此处添加工具过滤选项：--allow=getProjects,getTasks 或 --deny=deleteTask。
  6. 点击 "添加"。
• 版本 0.47 及以上：

    "Teamwork": {
      "command": "npx",
      "args": [
        "-y",
        "@vizioz/teamwork-mcp",
        "--domain",
        "yourdomain",
        "--user",
        "youruser@yourdomain.com",
        "--pass",
        "yourPassword"
      ]
    }

若需添加允许或否认的参数，可按如下操作：

    "Teamwork": {
      "command": "npx",
      "args": [
        "-y",
        "@vizioz/teamwork-mcp",
        "--domain",
        "yourdomain",
        "--user",
        "youruser@yourdomain.com",
        "--pass",
        "yourPassword",
        "--allow",
        "Tasks,Projects",
        "--deny",
        "getProjectsPeopleMetricsPerformance,getProjectsPeopleUtilization"
      ]
    }

完成上述操作后，Teamwork MCP 工具将在 Cursor 代理的作曲家中可用。

📄 许可证

此项目根据 MIT 许可证发布 - 请参阅 LICENSE 文件以获取详细信息。

⚠️ 免责声明

该项目与 Teamwork.com 无关，未得到其支持或赞助。包名 (@vizioz/teamwork-mcp) 中的 "Teamwork" 名称仅用于描述目的，以表明与 Teamwork.com API 的兼容性。