🚀 团队协作 MCP 项目文档
本项目是一个用于与 Teamwork.com 平台集成的 MCP（机器协调处理器）解决方案。借助该工具，您能直接在 Cursor 等工具中使用 Teamwork 的功能，有效简化开发流程。
🚀 快速开始
本项目是用于与 Teamwork.com 平台集成的 MCP 解决方案，可让您在 Cursor 等工具中使用 Teamwork 功能，简化开发流程。您可按以下步骤快速启动项目。
✨ 主要特性
- 团队管理：能轻松创建、更新和删除团队成员。
- 任务处理：可高效管理项目中的各项任务，涵盖创建、分配和跟踪进度等操作。
- API 集成：通过 RESTful API 实现与 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 服务器的文件。
💻 使用示例
运行 MCP 服务
基础用法
要以 MCP 服务器形式运行：
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 支持工具过滤功能。指定允许调用的工具或类别（允许列表）：
--allow=getProjects,getTasks
高级用法
排除不允许调用的工具或类别（排除列表）：
--deny=deleteTask,getProjectsPeopleMetricsPerformance
您可以在命令行中同时使用 --allow 和 --deny 参数，实现更灵活的控制。
项目配置
基础用法
在项目的根目录下创建一个名为 .teamwork 的文件，内容如下：
PROJECT_ID = YourTeamworkProjectID
此文件用于将您的解决方案与特定的 Teamwork 项目关联起来，从而减少不必要的 API 调用。
集成到 Cursor 指南
基础用法（Cursor 版本低于 0.47）
- 打开 Cursor 设置 > 功能 > MCP。
- 点击“+ 添加新 MCP 服务器”。
- 输入服务器名称（例如：“Teamwork API”）。
- 选择“stdio”作为传输类型。
- 输入运行服务器的命令：
npx @vizioz/teamwork-mcp，并添加所需的命令行参数，如域名、用户名和密码。 - 点击“添加”。
高级用法（Cursor 版本等于或高于 0.47）
在 config.json 文件中添加如下内容：
"Teamwork": {
"command": "npx",
"args": [
"-y",
"@vizioz/teamwork-mcp",
"--domain",
"your-company",
"--user",
"your-email@example.com",
"--pass",
"your-password"
]
}
📄 许可证
本项目遵循 MIT 许可证，具体内容如下：
版权所有 (c) 年份 作者名称
本软件在“原样”基础上提供，不附带任何明示或暗示的担保。
如需了解更多信息，请访问 Teamwork MCP 项目主页。