Teamwork

🚀 团队协作指南

Teamwork MCP（机器通信协议）项目是一款强大的工具，可用于与 Teamwork.com API 集成。借助它，您能通过命令行或其他 MCP 客户端（如 Cursor）轻松与 Teamwork 项目进行交互。本文档将为您详细介绍该工具的安装、配置和使用方法。

🚀 快速开始

本部分将引导您完成 Teamwork MCP 的安装与构建，助您快速开启使用之旅。

📦 安装指南

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