关键词

项目管理TapdSDKAPI客户端项目协作

项目简介

Tapd MCP Server SDK 是一个基于 Go 语言开发的 SDK 扩展，它将 go-tapd/tapd SDK 封装成一个 MCP (Model Context Protocol) 服务器。该服务器旨在为 LLM (大型语言模型) 客户端提供访问 Tapd 项目管理平台的能力，使得 LLM 能够获取项目上下文信息并调用 Tapd 的各种功能。

请注意： 该项目目前处于非稳定版本，不建议在生产环境中使用。

主要功能点

  • 资源访问能力: 通过 MCP 协议，LLM 客户端可以请求访问 Tapd 项目管理平台中的各种资源，例如：
    • 缺陷 (Bug) 信息
    • 迭代 (Iteration) 信息
    • 任务 (Task) 信息
    • 需求 (Story) 信息
    • 附件 (Attachment) 信息
    • 用户角色 (User Roles) 信息
  • 工具 (Tools) 注册和执行: MCP 服务器注册了一系列工具，允许 LLM 客户端调用 Tapd 的功能，例如：
    • 获取项目角色列表 (get_user_roles)
    • 获取需求模板列表 (get_story_template_list)

安装步骤

  1. 安装 Go 环境: 确保您的开发环境中已安装 Go 语言 (>= 1.23)。

  2. 获取仓库: 使用 'go get' 命令获取 'go-tapd/tapd' 仓库：

    go get github.com/go-tapd/tapd/cmd/tapd-mcp-server

服务器配置

MCP 服务器是为 MCP 客户端提供服务的后端应用。MCP 客户端需要配置服务器的启动命令和参数，才能连接到 MCP 服务器并使用其提供的功能。

以下是基于该仓库信息生成的 MCP 服务器配置（JSON 格式）：

{
  "server name": "tapd-mcp-server",
  "command": "tapd-mcp-server",
  "args": [],
  "description": "启动 Tapd MCP 服务器。需要设置 TAPD_CLIENT_ID, TAPD_CLIENT_SECRET, TAPD_WORKSPACE_ID 环境变量。",
  "envs": [
    {
      "name": "TAPD_CLIENT_ID",
      "value": "",
      "description": "您的 TAPD 客户端 ID，请在 TAPD 开放平台申请"
    },
    {
      "name": "TAPD_CLIENT_SECRET",
      "value": "",
      "description": "您的 TAPD 客户端密钥，请在 TAPD 开放平台申请"
    },
    {
      "name": "TAPD_WORKSPACE_ID",
      "value": "",
      "description": "您的 TAPD 项目 Workspace ID"
    }
  ]
}

配置参数说明:

  • server name: 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。
  • command: 启动 MCP 服务器的可执行文件命令，这里假设 'tapd-mcp-server' 命令已添加到系统环境变量中。
  • args: 启动命令的参数，该服务器不需要额外的命令行参数。
  • description: 服务器配置的描述信息，方便用户理解其作用。
  • envs: 重要 - 环境变量配置。MCP 服务器依赖以下环境变量进行 TAPD API 的身份验证和项目指定：
    • 'TAPD_CLIENT_ID': 必须配置。您的 TAPD 客户端 ID。
    • 'TAPD_CLIENT_SECRET': 必须配置。您的 TAPD 客户端密钥。
    • 'TAPD_WORKSPACE_ID': 必须配置。您要访问的 TAPD 项目的 Workspace ID。

请务必在 MCP 客户端中正确配置以上信息，并根据实际情况填写环境变量的值。

基本使用方法

  1. 配置环境变量: 在运行 MCP 服务器之前，请确保已设置 'TAPD_CLIENT_ID', 'TAPD_CLIENT_SECRET', 'TAPD_WORKSPACE_ID' 这三个环境变量。 您需要前往 TAPD 开放平台申请 'client_id' 和 'client_secret'，并获取您的项目 Workspace ID。

  2. 运行 MCP 服务器: 在命令行中执行 'tapd-mcp-server' 命令启动 MCP 服务器。

    tapd-mcp-server

    服务器默认使用 Stdio 传输协议，并通过标准输入/输出与 MCP 客户端通信。

  3. 配置 MCP 客户端: 在您的 LLM 应用或 MCP 客户端中，配置连接到该 MCP 服务器。您需要配置服务器的启动命令 (command) 和参数 (args)，以及必要的环境变量。 参考上面的 服务器配置 部分。

  4. 使用 MCP 客户端调用工具: 通过 MCP 客户端，您可以调用服务器提供的工具，例如 'get_user_roles' 和 'get_story_template_list'，以获取 Tapd 项目中的数据。 具体工具的使用方法请参考 MCP 客户端的文档和工具的描述信息。

注意: 由于该 MCP 服务器是基于 Stdio 传输协议，您需要在支持 Stdio 协议的 MCP 客户端中使用。

信息

分类

商业系统

访问项目