Teamwork MCP server

The Teamwork MCP server provides a simplified interface for interacting with Teamwork projects and tasks through a Model Context Protocol (MCP) server, allowing easy integration with applications like Cursor and Claude Desktop.

Installation

The easiest way to use Teamwork MCP is with npx:

npx @vizioz/teamwork-mcp

You can also pass configuration options directly:

npx @vizioz/teamwork-mcp --domain=your-company [email protected] --pass=your-password

Configuration

Setting Credentials

You can provide your Teamwork credentials in three ways:

1. Environment Variables: Set TEAMWORK_DOMAIN, TEAMWORK_USERNAME, and TEAMWORK_PASSWORD in your environment.

2. .env File: Create a .env file with the required variables:

   TEAMWORK_DOMAIN=your-company
   [email protected]
   TEAMWORK_PASSWORD=your-password
   

3. Command Line Arguments: Pass credentials when running the application:

   npx @vizioz/teamwork-mcp --teamwork-domain=your-company [email protected] --teamwork-password=your-password
   

   Or using short form:

   npx @vizioz/teamwork-mcp --domain=your-company [email protected] --pass=your-password
   

Logging Configuration

You can disable logging using:

npx @vizioz/teamwork-mcp --disable-logging

Or:

DISABLE_LOGGING=true npx @vizioz/teamwork-mcp

Tool Filtering

You can control which tools are available:

1. Allow List: Only expose specific tools:

   npx @vizioz/teamwork-mcp --allow-tools=getProjects,getTasks,getTaskById
   

   Or using short form:

   npx @vizioz/teamwork-mcp --allow=getProjects,getTasks,getTaskById
   

2. Deny List: Expose all tools except those specified:

   npx @vizioz/teamwork-mcp --deny-tools=deleteTask,updateTask
   

   Or using short form:

   npx @vizioz/teamwork-mcp --deny=deleteTask,updateTask
   

Tool Filtering with Groups

You can specify groups of tools for filtering:

npx @vizioz/teamwork-mcp --allow-tools=Tasks,People

Available groups: Projects, Tasks, People, Reporting, Time, Comments

Setting Up Your Teamwork Project

To associate your current solution with a Teamwork project, create a .teamwork file in the root of your project:

PROJECT_ID = YourTeamworkProjectID

Available Tools

Project Tools

• getProjects - Get all projects from Teamwork
• getCurrentProject - Gets details about the current project
• createProject - Create a new project in Teamwork

Task Tools

• getTasks - Get all tasks from Teamwork
• getTasksByProjectId - Get all tasks from a specific project
• getTaskListsByProjectId - Get all task lists from a specific project
• getTasksByTaskListId - Gets all tasks from a specific task list ID
• getTaskById - Get a specific task by ID
• createTask - Create a new task
• createSubTask - Create a new subtask under a parent task
• updateTask - Update an existing task
• deleteTask - Delete a task
• getTasksMetricsComplete - Get the total count of completed tasks
• getTasksMetricsLate - Get the total count of late tasks
• getTaskSubtasks - Get all subtasks for a specific task
• getTaskComments - Get comments for a specific task

Comment Tools

• createComment - Create a comment related to a task/message/notebook

Company Tools

• getCompanies - Get all companies with optional filtering
• getCompanyById - Get a specific company by ID
• createCompany - Create a new company
• updateCompany - Update an existing company's information
• deleteCompany - Delete a company

People Tools

• getPeople - Get all people
• getPersonById - Get a specific person by ID
• getProjectPeople - Get all people assigned to a specific project
• addPeopleToProject - Add people to a specific project
• deletePerson - Delete a person
• updatePerson - Update a person's information
• getProjectsPeopleMetricsPerformance - Get people metrics performance
• getProjectsPeopleUtilization - Get people utilization
• getProjectPerson - Get a specific person on a project

Reporting Tools

• getProjectsReportingUserTaskCompletion - Get user task completion report
• getProjectsReportingUtilization - Get utilization report

Time Tools

• getTime - Get all time entries
• getProjectsAllocationsTime - Get project allocations time
• getTimezones - Get all available timezones

Adding to MCP Clients

Cursor

Versions before 0.47

1. Open Cursor Settings > Features > MCP
2. Click "+ Add New MCP Server"
3. Enter a name for the server (e.g., "Teamwork API")
4. Select "stdio" as the transport type
5. Enter the command: npx @vizioz/teamwork-mcp with your credentials
6. Click "Add"

Versions after 0.47 (editing the config manually)

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

Claude Desktop

Edit your Claude Desktop configuration file:

Windows: %APPDATA%\Claude\claude_desktop_config.json macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Add the following configuration:

{
  "mcpServers": {
    "teamwork": {
      "command": "npx",
      "args": [
        "-y",
        "@vizioz/teamwork-mcp",
        "--domain",
        "yourdomain",
        "--user",
        "[email protected]",
        "--pass",
        "yourPassword"
      ]
    }
  }
}

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "Teamwork" '{"command":"npx","args":["-y","@vizioz/teamwork-mcp","--domain","yourdomain","--user","[email protected]","--pass","yourPassword"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "Teamwork": {
            "command": "npx",
            "args": [
                "-y",
                "@vizioz/teamwork-mcp",
                "--domain",
                "yourdomain",
                "--user",
                "[email protected]",
                "--pass",
                "yourPassword"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "Teamwork": {
            "command": "npx",
            "args": [
                "-y",
                "@vizioz/teamwork-mcp",
                "--domain",
                "yourdomain",
                "--user",
                "[email protected]",
                "--pass",
                "yourPassword"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect