Teamwork MCP

🚀 Teamwork Tool - Teamwork MCP Server

The Teamwork MCP Server is an integrated module (MCP) designed for the Teamwork platform, used to interact with other tools such as Cursor. Through this MCP, you can directly perform various tasks and operations on Teamwork.

🚀 Quick Start

📦 Installation

Using NPX (Recommended)

The easiest way is to use NPX to run the MCP:

npx teamwork-mcp

If you need to configure 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 want to build the code yourself:

npm run build

This command will compile the TypeScript code into a directly runnable MCP server.

Running as an MCP Server

To run as an MCP server and integrate with other applications, assuming you use a .env file or environment variables to configure the username, password, and URL:

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

Or pass the configuration through command-line arguments:

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

You can also use the shorthand form:

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

Using the MCP Inspection Tool

To run the MCP inspection tool for debugging:

npm run inspector

💻 Usage Examples

Configuring the Teamwork Project

To associate your current solution with a Teamwork project, you can create a .teamwork file with the following content:

PROJECT_ID = YourTeamworkProjectID

This configuration file is used to identify a specific Teamwork project, and more detailed information may be added in the future.

Once configured, the MCP will be able to identify your Teamwork project and associate it with the current solution, thereby reducing the number of API calls required to retrieve projects and tasks.

Adding to Cursor (and other MCP clients)

For versions below 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 in the command field: npx @vizioz/teamwork-mcp and add the required command-line parameters, such as domain, username, and password.
   • You can add tool filtering options here: --allow=getProjects,getTasks or --deny=deleteTask
6. Click "Add"

For version 0.47 and above:

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

If you need to add allow or deny parameters, you can do it like this:

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

Now, the Teamwork MCP tool will be available in the Cursor proxy composer.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Disclaimer

This project is not affiliated with, supported, or sponsored by Teamwork.com. The "Teamwork" name in the package name (@vizioz/teamwork-mcp) is used for descriptive purposes only to indicate compatibility with the Teamwork.com API.