Teamwork

🚀 Team Collaboration Guide

The Teamwork MCP (Machine Communication Protocol) project is a powerful tool for integrating with the Teamwork.com API. It allows you to easily interact with your Teamwork projects via the command line or other MCP clients (such as Cursor). This document will guide you on how to install, configure, and use this tool.

🚀 Quick Start

📦 Installation

Using NPX (Recommended)

The simplest way to use it is to run it via NPX:

npx teamwork-mcp

If you need to pass configuration options, you can do it like this:

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

Building the Application

If you need to build it manually:

npm run build

This will compile the TypeScript code into files that can be used for the MCP server.

✨ Features

Teamwork MCP supports multiple team collaboration modes, allowing you to interact with projects via the command line or other MCP clients. Here is a list of core features:

• Get Projects: getProjects
• Get Tasks: getTasks
• Create Task: createTask
• Update Task: updateTask
• Delete Task: deleteTask
• Associate Project: associateProject

📚 Documentation

Setting Up a Teamwork Project

Using a Configuration File

Create a .teamwork file in the project root directory with the following content:

PROJECT_ID = Your Teamwork project ID

This will help MCP automatically identify your project.

Usage

Running as an MCP Server

To run in MCP server mode (for integration with Cursor or other applications):

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

Or pass credentials via the command line:

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

Configuration for Cursor (and Other MCP Clients)

For Cursor versions before 0.47

1. Open Cursor Settings > Features > MCP
2. Click “+ Add New MCP Server”
3. Enter the server name (e.g., “Teamwork API”)
4. Select “stdio” as the transport type
5. Enter the following in the command box: npx @vizioz/teamwork-mcp --domain your-company --user your-email@example.com --pass your-password
6. Click “Add”

For Cursor versions 0.47 and later

Add the following to the configuration file:

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

📄 License

This project is licensed under the MIT license. Please refer to the LICENSE file for details.

⚠️ Important Note

This project has no affiliation with Teamwork.com. The name “Teamwork” is only used to describe compatibility with the Teamwork.com API and does not imply any form of sponsorship or endorsement.