Teamwork MCP

🚀 團隊合作 MCP 項目文檔

Teamwork MCP 是一款與 Teamwork.com 平臺集成的工具，為 Cursor 等 MCP 客戶端提供支持。它採用 TypeScript 編寫，擁有豐富的 API 方法，可用於交互和管理 Teamwork 項目、任務及其他資源。

🚀 快速開始

Teamwork MCP 能幫助你輕鬆與 Teamwork.com 平臺集成，為 MCP 客戶端提供支持。下面為你介紹如何快速開啟使用之旅。

✨ 主要特性

• 與 Teamwork.com 平臺集成，為 Cursor 等 MCP 客戶端提供支持。
• 使用 TypeScript 編寫，提供豐富的 API 方法用於交互和管理 Teamwork 項目、任務和其他資源。

📦 安裝指南

使用 NPX（推薦）

最簡單的使用方式是通過 NPX 運行：

npx teamwork-mcp

你還能通過傳遞配置選項來運行：

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

構建應用

注意：若你僅想使用 MCP，可直接使用 NPX 指令，無需構建。 構建應用的命令如下：

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 將能夠自動識別你的項目，並減少獲取項目和相關任務所需的 API 調用數量。

使用說明

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

如果你使用的是 Cursor 的早期版本（0.47 以下）：

1. 打開 Cursor 設置 > 功能 > MCP。
2. 點擊“+ 添加新 MCP 服務器”。
3. 輸入服務器名稱（例如：“Teamwork API”）。
4. 選擇傳輸類型為“stdio”。
5. 在命令行中輸入運行服務器的命令：npx @vizioz/teamwork-mcp，並添加所需的憑證和域命令行參數。
   • 你可以通過 --allow=getProjects,getTasks 或 --deny=deleteTask 等選項進行工具過濾。
6. 點擊“添加”。

如果你使用的是 Cursor 的版本 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"
      ]
    }

📄 許可證

該項目的授權協議為 MIT License。

⚠️ 重要提示

本項目僅為示例用途，使用前請仔細閱讀相關文檔和條款。