使用说明

项目简介

Teamwork AI MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在桥接大型语言模型 (LLM) 客户端和 Teamwork.com 项目管理平台。它允许 AI 智能体通过标准化的 MCP 协议,安全地访问和操作 Teamwork.com 中的项目数据和功能,从而实现更智能的项目管理自动化和辅助。

主要功能点

  • 资源 (Resources) 管理: 提供对 Teamwork.com 中多种项目管理实体(如项目、任务列表、任务、用户、公司、技能、标签、里程碑和行业)的只读访问能力。LLM 客户端可以通过标准化的 URI 访问这些资源,获取项目上下文信息。
  • 工具 (Tools) 注册与执行: 注册了一系列工具,允许 LLM 客户端调用 Teamwork.com 的功能,例如:
    • 创建、检索和更新项目、任务列表、任务、公司/客户、用户/人员、技能、标签和里程碑等实体。
    • 支持按项目检索任务列表、按项目或任务列表检索任务、按项目检索用户和里程碑等。
  • 支持多种运行模式: 支持本地 'stdio' 模式和远程 'sse' 模式,可以灵活部署和集成到不同的 LLM 应用环境中。

安装步骤

  1. 安装 Go 环境: 确保您的系统已安装 Go 语言环境 (>= 1.20)。
  2. 获取仓库代码: 使用 'git clone https://github.com/rafaeljusto/teamwork-ai' 克隆仓库到本地。
  3. 编译服务器: 在仓库根目录下,进入 'cmd/mcp' 目录,执行 'go build' 命令编译生成可执行文件 'teamwork-mcp' (或 'teamwork-mcp.exe' on Windows)。
  4. 安装可执行文件: 将编译生成的可执行文件 'teamwork-mcp' 移动到您的系统 'PATH' 环境变量包含的目录中,以便 LLM 客户端能够找到并执行它。

服务器配置

以下是配置 MCP 服务器以与 Claude Desktop 等 MCP 客户端连接的示例 (JSON 格式):

本地 Stdio 模式配置 (推荐 Claude Desktop 使用)

{
  "mcpServers": {
    "Teamwork AI": {
      "command": "teamwork-mcp",  // MCP 服务器启动命令,假设 teamwork-mcp 已添加到 PATH 环境变量
      "args": [
        "-mode=stdio"           // 运行参数,指定使用 stdio 模式
      ],
      "env": {
        "TWAI_TEAMWORK_SERVER": "https://<installation>.teamwork.com",  // 您的 Teamwork.com 安装地址,例如:https://yourcompany.teamwork.com
        "TWAI_TEAMWORK_API_TOKEN": "<api-token>"                      // 您的 Teamwork.com API 令牌,需要有足够的权限执行所需操作
      }
    }
  }
}

远程 SSE 模式配置

{
  "mcpServers": {
    "Teamwork AI Remote": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://<server>/sse"   // 远程 MCP 服务器的 SSE 端点 URL,例如:https://your-server.com/sse
      ]
    }
  }
}

配置说明:

  • '"server name"': MCP 服务器的名称,可以自定义,用于在 MCP 客户端中标识和选择。例如 '"Teamwork AI"' 或 '"Teamwork AI Remote"'。
  • '"command"': 启动 MCP 服务器的命令。本地 'stdio' 模式通常为 '"teamwork-mcp"'(假设已添加到 PATH),远程 'sse' 模式可以使用 'npx mcp-remote'。
  • '"args"': 传递给启动命令的参数。
    • 'stdio' 模式示例中,使用 '"-mode=stdio"' 参数指定运行模式。
    • 'sse' 模式示例中,使用 '"mcp-remote"' 和服务器 SSE 端点 URL 作为参数。
  • '"env"' (仅 'stdio' 模式): 设置 MCP 服务器运行所需的环境变量。
    • '"TWAI_TEAMWORK_SERVER"': Teamwork.com 的安装地址。
    • '"TWAI_TEAMWORK_API_TOKEN"': Teamwork.com API 令牌。

重要提示: 请务必替换 '<installation>'、'<api-token>' 和 '<server>' 为您实际的 Teamwork.com 安装地址、API 令牌和服务器 URL。API 令牌需要具备执行 LLM 客户端请求操作的足够权限。

基本使用方法

  1. 配置 MCP 客户端: 在支持 MCP 协议的 LLM 客户端(如 Claude Desktop)中,根据上述配置示例,添加 "Teamwork AI" 或 "Teamwork AI Remote" MCP 服务器配置。

  2. 与 LLM 交互: 在 LLM 客户端中,可以使用自然语言指令指示 AI 智能体与 Teamwork.com 进行交互。例如:

    Could you please create a projects with the steps to create a new house?

    AI 客户端会将该指令通过 MCP 协议发送到 Teamwork AI MCP Server,服务器会解析请求并调用相应的 Teamwork.com API 创建项目和任务。您可以通过类似的自然语言指令,利用 AI 智能体完成更多 Teamwork.com 的操作,例如任务分配、信息查询等。

信息

分类

生产力应用