Teamwork MCP 2j9

🚀 Team Collaboration MCP Project Documentation

This project is an MCP (Machine Coordination Processor) solution integrated with the Teamwork.com platform. With this tool, you can use Teamwork's features directly in tools like Cursor, streamlining the development process.

🚀 Quick Start

This project offers an MCP solution for seamless integration with the Teamwork.com platform. It allows you to leverage Teamwork's features directly within tools like Cursor, thereby streamlining the development process.

✨ Features

• Team Management: Effortlessly create, update, and remove team members.
• Task Handling: Efficiently manage all tasks in the project, including creation, assignment, and progress tracking.
• API Integration: Achieve deep integration with the Teamwork platform through RESTful APIs.
• Command-line Tool: Support invoking MCP functions via the command line to enhance automation capabilities.

📦 Installation

Quick Start with NPX (Recommended)

You can directly run the project using NPX:

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

Local Build

If you wish to compile the code yourself:

npm run build

This command will compile the TypeScript code and generate files for the MCP server.

Running the MCP Service

To run it as an MCP server:

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

Or pass configuration parameters 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

Short Format Options

You can also use the short parameter form:

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

Tool Filtering Guide

To enhance security, MCP supports a tool filtering feature, specifically including the following two methods:

Allow List (--allow)

Specify the tools or categories allowed to be called. For example:

--allow=getProjects,getTasks

Deny List (--deny)

Exclude tools or categories that are not allowed to be called. For example:

--deny=deleteTask,getProjectsPeopleMetricsPerformance

You can use both the --allow and --deny parameters in the command line for more flexible control.

Project Configuration File

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

PROJECT_ID = YourTeamworkProjectID

This file is used to associate your solution with a specific Teamwork project, thereby reducing unnecessary API calls.

Integration Guide for Cursor

For Cursor 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 the command to run the server: npx @vizioz/teamwork-mcp, and add the required command-line parameters such as domain, username, and password.
6. Click “Add”.

For Cursor Versions 0.47 and Above

Add the following content to the config.json file:

    "Teamwork": {
      "command": "npx",
      "args": [
        "-y",
        "@vizioz/teamwork-mcp",
        "--domain",
        "your-company",
        "--user",
        "your-email@example.com",
        "--pass",
        "your-password"
      ]
    }

📄 License

This project is licensed under the MIT License, and the specific content is as follows:

Copyright (c) Year Author Name
This software is provided "as is" without any express or implied warranty.

For more information, please visit Teamwork MCP Project Homepage.