TeamRetro MCP Server 使用说明

项目简介

TeamRetro MCP Server 是一个社区开发的非官方 MCP 服务器，旨在桥接 TeamRetro 协作平台与支持 Model Context Protocol (MCP) 的大型语言模型 (LLM) 应用。通过此服务器，LLM 客户端可以安全、可控地访问 TeamRetro 的部分功能，例如查询团队信息，从而扩展 LLM 在工作协作场景中的应用能力。

请注意： 这是一个非官方集成项目，与 TeamRetro 官方及其母公司没有关联，未获得官方认可或支持。所有 API 调用均直接通过 TeamRetro 的公共 API 接口，服务器不对请求或响应做任何修改，仅负责协议转换和工具封装。

主要功能点

提供 TeamRetro 团队数据访问能力： 通过 MCP 协议向 LLM 客户端提供对 TeamRetro 团队信息的访问，目前支持列出团队和获取团队详情。
注册和执行工具 (Tools)： 已注册 'list_teams' 和 'get_team' 两个工具，允许 LLM 客户端通过调用这些工具来获取 TeamRetro 中的团队数据。
基于 TeamRetro 公共 API： 所有功能均基于 TeamRetro 官方提供的公共 API 文档实现，保证了功能与 TeamRetro API 的一致性。
多种身份验证方式支持： 支持 API 密钥、Basic Authentication 和 Bearer Token 三种身份验证方式，用户可以根据 TeamRetro API 的要求选择合适的验证方式。

安装步骤

克隆仓库:

git clone https://github.com/adepanges/teamretro-mcp-server.git
cd teamretro-mcp-server

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

要将 TeamRetro MCP Server 集成到 MCP 客户端（例如 Claude），您需要配置客户端的 MCP 设置。以下是针对本地开发环境的配置示例，请根据您的实际 'teamretro-mcp-server' 项目路径进行调整：

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

配置参数说明:

'server name': 'teamretro-mcp-server' (服务器名称，客户端用于标识和调用)
'command': 'node' (运行服务器的命令，这里使用 Node.js)
'args': '["/path/to/teamretro-mcp-server/dist/index.js"]' (启动服务器的参数，指向编译后的 'index.js' 文件路径，请替换为您的实际路径)
'env': 环境变量配置，用于服务器连接 TeamRetro API：
- 'TEAMRETRO_BASE_URL': 'https://api.teamretro.com' (TeamRetro API 的基础 URL，默认值，通常无需修改)
- 'TEAMRETRO_AUTH_TYPE': 'apiKey' (身份验证类型，可选 'apiKey', 'basic', 'bearer'，默认为 'apiKey')
- 'TEAMRETRO_API_KEY': 'your-api-key' (TeamRetro API 密钥，请替换为您的实际 API 密钥)
- 'TEAMRETRO_USERNAME': 'your-username' (当 'TEAMRETRO_AUTH_TYPE' 为 'basic' 时使用，TeamRetro 用户名)
- 'TEAMRETRO_PASSWORD': 'your-password' (当 'TEAMRETRO_AUTH_TYPE' 为 'basic' 时使用，TeamRetro 密码)
- 'TEAMRETRO_TOKEN': 'your-bearer-token' (当 'TEAMRETRO_AUTH_TYPE' 为 'bearer' 时使用，Bearer Token)

请务必根据您的 TeamRetro 账户和 API 密钥信息，以及选择的身份验证方式，正确配置 'env' 字段中的环境变量。

基本使用方法

配置完成后，您的 MCP 客户端（如 Claude）应该能够检测到 'teamretro-mcp-server' 并与之建立连接。您可以指示 LLM 调用以下工具来访问 TeamRetro 数据：

'list_teams': 列出 TeamRetro 中的团队。该工具支持可选的输入参数，例如 'offset' (起始索引), 'limit' (返回数量), 'teamTags' (按团队标签过滤), 'teamIds' (按团队 ID 过滤)。
'get_team': 获取指定 TeamRetro 团队的详细信息。需要提供 'teamId' 作为输入参数。

具体工具调用方式和参数使用请参考您的 MCP 客户端的文档。

关键词