TeamRetro MCP 服务器

用于 TeamRetro 集成的 Model Context Protocol (MCP) 服务器。

重要说明

非官方 MCP 服务器

此 MCP 服务器是一个非官方社区开发的接口，用于访问 TeamRetro 的服务。虽然不是由 TeamRetro 开发或支持的，但它提供了对其平台的标准化访问。

官方 API 集成

该服务器直接连接到 TeamRetro 的官方公共 API：

• 使用来自 TeamRetro API 规范文档中的端点
• 保持完整的 API 兼容性和版本跟踪
• 实现所有必需的身份验证方法
• 保留原始 API 响应而不做任何修改

API 文档来源

所有 API 端点和功能均基于 TeamRetro 的官方文档：

• API 帮助文章: https://help.teamretro.com/article/320-teamretro-api
• API 规范: https://groupmap.stoplight.io/docs/teamretro/
• 实现严格遵循公共 API 规范
• TeamRetro API 的任何更改都可能影响此 MCP 服务器的功能

如何使用

NPX（推荐，易于设置）

{
  "mcpServers": {
    "teamretro-mcp-server": {
      "command": "npx",
      "args": ["-y", "teamretro-mcp-server"],
      "env": {
        "TEAMRETRO_AUTH_TYPE": "apiKey",
        "TEAMRETRO_API_KEY": "your-api-key"
      }
    }
  }
}

从源代码开始

1. 克隆仓库，安装依赖项，并构建项目：

git clone https://github.com/adepanges/teamretro-mcp-server.git
cd teamretro-mcp-server
npm install
npm run build

在 AI 客户端中运行

1. 使用以下设置配置 AI 客户端：

{
  "mcpServers": {
    "teamretro-mcp-server": {
      "command": "node",
      "args": ["/path/to/teamretro-mcp-server/dist/index.js"],
      "env": {
        "TEAMRETRO_AUTH_TYPE": "apiKey",
        "TEAMRETRO_API_KEY": "your-api-key"
      }
    }
  }
}

使用 Inspector 运行

1. 通过复制 .env.example 到 .env 并根据需要进行修改来配置环境变量。
2. 使用 inspector 运行服务器：

npm run inspector

环境变量示例

基础 URL

可以通过 TEAMRETRO_BASE_URL 环境变量设置 TeamRetro API 的基础 URL。默认情况下，它被设置为 https://api.teamretro.com。

{
  "env": {
    "TEAMRETRO_BASE_URL": "https://api.teamretro.com"
  }
}

API 密钥认证

{
  "env": {
    "TEAMRETRO_AUTH_TYPE": "apiKey",
    "TEAMRETRO_API_KEY": "your-api-key"
  }
}

可用工具

服务器提供以下工具：

用户

• list_users: 使用偏移量和限制参数进行分页，列出用户并控制返回的结果数量
• add_user: 通过电子邮件地址添加新用户或更新现有用户信息，可选指定姓名和电子邮件地址
• update_user: 通过提供当前电子邮件地址来更新现有用户的详细信息，如姓名和电子邮件地址
• delete_user: 通过电子邮件地址删除用户
• get_user: 通过电子邮件地址检索单个用户的详细信息

团队

• list_teams: 通过标签和 ID 过滤以及使用偏移量和限制参数进行分页，列出 TeamRetro 中的团队
• detail_team: 通过其唯一 ID 检索单个团队的详细信息
• update_team: 通过提供团队 ID 来更新现有团队的详细信息，如名称和关联标签
• create_team: 创建一个新团队，需要名称，可选标签和成员
• delete_team: 通过其 ID 删除现有团队

团队成员

• list_team_members: 通过分页控制（偏移量和限制）检索指定团队ID的团队成员列表
• get_team_member: 在指定团队中通过电子邮件地址获取团队成员
• update_team_member: 在指定团队中通过电子邮件地址更新团队成员的详细信息，如姓名或团队管理员状态
• remove_team_member: 通过电子邮件地址从团队中移除团队成员
• add_team_member: 通过电子邮件地址向团队添加新成员，并可选地指定团队管理员状态

操作

• list_actions: 从TeamRetro检索操作列表，可选地通过团队标签和团队ID进行过滤，并使用分页控制（偏移量和限制）
• create_action: 在TeamRetro中创建一个新的操作，需要提供团队ID、标题、截止日期、完成状态和分配用户等详细信息
• get_action: 从TeamRetro通过其唯一ID获取单个操作
• update_action: 更新TeamRetro中的现有操作，提供新的详细信息，如标题、截止日期、完成状态、优先级和分配用户
• delete_action: 通过操作ID从TeamReto删除现有的操作

协议

• list_agreements: 列出TeamRetro中的协议，可选地通过团队标签和团队ID进行过滤，并使用分页控制
• create_agreement: 通过指定所属团队及其标题在TeamRetro中创建一个新协议
• get_agreement: 通过其唯一标识符检索单个协议
• update_agreement: 更新现有协议的详细信息，如标题或关联团队
• delete_agreement: 通过指定其唯一标识符删除现有协议

健康检查

• list_health_checks: 从TeamRetro列出健康检查，可选地通过健康模型ID、团队标签和团队ID进行过滤，并使用分页控制
• get_health_check: 通过其唯一标识符检索单个健康检查，可选地包括特定属性
• delete_health_check: 通过指定其唯一标识符删除现有健康检查

健康模型

• list_health_models: 从TeamRetro列出健康模型，并使用分页控制
• get_health_model: 通过其唯一标识符检索单个健康模型

回顾

• list_retrospectives: 从TeamRetro列出回顾会议，可通过团队标签和ID进行过滤，并使用偏移量和限制参数进行分页
• get_retrospective: 通过其唯一ID获取关于单个回顾会议的详细信息
• delete_retrospective: 通过ID删除现有的回顾会议

变更日志

有关详细的变更和更新列表，请参阅 CHANGELOG.md。