Teamwork MCP

🚀 团队合作 MCP 项目文档

Teamwork MCP 是一款与 Teamwork.com 平台集成的工具，为 Cursor 等 MCP 客户端提供支持。它采用 TypeScript 编写，拥有丰富的 API 方法，可用于交互和管理 Teamwork 项目、任务及其他资源。

🚀 快速开始

Teamwork MCP 能帮助你轻松与 Teamwork.com 平台集成，为 MCP 客户端提供支持。下面为你介绍如何快速开启使用之旅。

✨ 主要特性

• 与 Teamwork.com 平台集成，为 Cursor 等 MCP 客户端提供支持。
• 使用 TypeScript 编写，提供丰富的 API 方法用于交互和管理 Teamwork 项目、任务和其他资源。

📦 安装指南

使用 NPX（推荐）

最简单的使用方式是通过 NPX 运行：

npx teamwork-mcp

你还能通过传递配置选项来运行：

npx teamwork-mcp --domain=your-company --user=your-email@example.com --pass=your-password

构建应用

注意：若你仅想使用 MCP，可直接使用 NPX 指令，无需构建。 构建应用的命令如下：

npm run build

此命令会编译 TypeScript 代码，以便作为 MCP 服务器运行。

运行 MCP 服务器

若你想以 MCP 服务器的形式运行该项目（用于与其他应用程序集成）： 假设你已使用 .env 文件保存用户名、密码和 URL，或者已将其设置为环境变量：

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

你也能使用简写形式：

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

使用 MCP 检查工具（用于调试）

要运行 MCP 检查工具进行调试，可执行以下命令：

npm run inspector

📚 详细文档

配置 Teamwork 项目

为了将你的解决方案与 Teamwork 项目关联，可在项目根目录创建一个 .teamwork 文件，结构如下：

PROJECT_ID = YourTeamworkProjectID

此配置文件用于标识你的解决方案对应的 Teamwork 项目，未来可能会添加更多详细信息。配置完成后，MCP 将能够自动识别你的项目，并减少获取项目和相关任务所需的 API 调用数量。

使用说明

添加到 Cursor（及其他 MCP 客户端）

如果你使用的是 Cursor 的早期版本（0.47 以下）：

1. 打开 Cursor 设置 > 功能 > MCP。
2. 点击“+ 添加新 MCP 服务器”。
3. 输入服务器名称（例如：“Teamwork API”）。
4. 选择传输类型为“stdio”。
5. 在命令行中输入运行服务器的命令：npx @vizioz/teamwork-mcp，并添加所需的凭证和域命令行参数。
   • 你可以通过 --allow=getProjects,getTasks 或 --deny=deleteTask 等选项进行工具过滤。
6. 点击“添加”。

如果你使用的是 Cursor 的版本 0.47 或以上（手动编辑配置文件）：

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

如果你想添加工具过滤选项，可以这样做：

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

📄 许可证

该项目的授权协议为 MIT License。

⚠️ 重要提示

本项目仅为示例用途，使用前请仔细阅读相关文档和条款。