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 的兼容性。