团队协作指南

简介

Teamwork MCP（机器通信协议）项目是一个用于与Teamwork.com API集成的强大工具。它允许您通过命令行或其他MCP客户端（如Cursor）轻松与您的Teamwork项目交互。本文档将指导您如何安装、配置和使用该工具。

安装与构建

使用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。