Teamwork

🚀 團隊協作指南

Teamwork MCP（機器通信協議）項目是一款強大的工具，可用於與 Teamwork.com API 集成。藉助它，您能通過命令行或其他 MCP 客戶端（如 Cursor）輕鬆與 Teamwork 項目進行交互。本文檔將為您詳細介紹該工具的安裝、配置和使用方法。

🚀 快速開始

本部分將引導您完成 Teamwork MCP 的安裝與構建，助您快速開啟使用之旅。

📦 安裝指南

使用 NPX（推薦）

最簡單的使用方式是通過 NPX 運行，命令如下：

npx teamwork-mcp

若您需要傳遞配置選項，可按以下命令操作：

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

構建應用程序

若需手動構建，可執行以下命令：

npm run build

此命令會將 TypeScript 代碼編譯為可用於 MCP 服務器的文件。

✨ 主要特性

Teamwork MCP 支持多種團隊協作模式，允許您通過命令行或其他 MCP 客戶端與項目交互。核心功能如下：

• 獲取項目：getProjects
• 獲取任務：getTasks
• 創建任務：createTask
• 更新任務：updateTask
• 刪除任務：deleteTask
• 關聯項目：associateProject

📚 詳細文檔

設置 Teamwork 項目

使用配置文件

在項目根目錄中創建一個 .teamwork 文件，內容如下：

PROJECT_ID = 您的 Teamwork 項目 ID

這將幫助 MCP 自動識別您的項目。

使用方法

作為 MCP 服務器運行

要以 MCP 服務器模式運行（用於與 Cursor 或其他應用程序集成），可執行以下命令：

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

配置到 Cursor（及其他 MCP 客戶端）

適用於版本 0.47 之前的 Cursor

1. 打開 Cursor 設置 > 功能 > MCP
2. 點擊“+ 添加新 MCP 服務器”
3. 輸入服務器名稱（例如：“Teamwork API”）
4. 選擇“stdio”作為傳輸類型
5. 在命令框中輸入：npx @vizioz/teamwork-mcp --domain your-company --user your-email@example.com --pass your-password
6. 點擊“添加”

適用於版本 0.47 及以後的 Cursor

在配置文件中添加以下內容：

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

📄 許可證

此項目採用 MIT 許可證，詳情請參閱 LICENSE 文件。

⚠️ 重要提示

該項目與 Teamwork.com 無任何關聯。名稱“Teamwork”僅用於描述與 Teamwork.com API 的兼容性，不涉及任何形式的贊助或 endorsement。