Сервер TeamRetro MCP

Сервер Model Context Protocol (MCP) для интеграции TeamRetro.

Важные примечания

Неофициальный MCP-сервер

Этот сервер MCP — неофициальный интерфейс, разработанный сообществом для сервисов TeamRetro. Хотя он не разработан и не одобрен TeamRetro, он обеспечивает стандартизированный доступ к их платформе.

Официальная интеграция API

Сервер подключается напрямую к официальному публичному API TeamRetro:

• Использует документированные конечные точки из спецификаций API TeamRetro.

• Поддерживает полное соответствие API и отслеживание версий

• Реализует все необходимые методы аутентификации

• Сохраняет оригинальные ответы API без изменений.

Источник документации API

Все конечные точки и функциональные возможности API основаны на официальной документации TeamRetro:

• Статья справки по API: https://help.teamretro.com/article/320-teamretro-api

• Спецификации API: https://groupmap.stoplight.io/docs/teamretro/

• Реализация строго соответствует публичным спецификациям API.

• Любые изменения в API TeamRetro могут повлиять на функциональность этого сервера MCP.

Related MCP server: MCP Server with Authentication

Как использовать

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. Настройте клиент ИИ со следующими параметрами:

{
  "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"
      }
    }
  }
}

Бег с инспектором

1. Настройте переменные среды, скопировав .env.example в .env и изменив его в соответствии с вашими потребностями.

2. Запустите сервер с помощью инспектора:

npm run inspector

Примеры переменных окружения

Базовый URL-адрес

Базовый URL для API TeamRetro можно задать с помощью переменной среды TEAMRETRO_BASE_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 : Добавить нового пользователя или обновить информацию о существующем пользователе по его адресу электронной почты, указав необязательное имя и emailAddress

• update_user : обновить данные существующего пользователя, такие как его имя и адрес электронной почты, указав его текущий адрес электронной почты.

• delete_user : Удалить пользователя по адресу электронной почты

• get_user : получение подробной информации об одном пользователе по его адресу электронной почты

Команды

• list_teams : список команд из TeamRetro с фильтрацией по тегам и идентификаторам, а также разбиением на страницы с использованием параметров смещения и ограничения.

• detail_team : Получить подробную информацию об одной команде по ее уникальному идентификатору

• update_team : обновить данные существующей команды, такие как ее название и связанные теги, указав идентификатор команды.

• create_team : создать новую команду с обязательным названием и необязательными тегами и участниками.

• delete_team : Удалить существующую команду по ее идентификатору

Члены команды

• list_team_members : получение списка членов команды для указанного идентификатора команды с элементами управления постраничной навигацией для смещения и ограничения

• get_team_member : Получить члена команды по его адресу электронной почты в пределах указанной команды

• update_team_member : обновить данные члена команды, такие как его имя или статус администратора команды, по его адресу электронной почты в указанной команде

• remove_team_member : Удалить члена команды из команды по его адресу электронной почты

• add_team_member : Добавить нового члена команды в команду по его адресу электронной почты с необязательным указанием статуса администратора команды.

Действия

• list_actions : Извлечение списка действий из TeamRetro с дополнительной фильтрацией по тегам и идентификаторам команд, а также элементами управления разбиением на страницы для смещения и ограничения.

• create_action : создать новое действие в TeamRetro с необходимыми данными, такими как идентификатор команды, название, дата выполнения, статус завершения и назначенный пользователь.

• get_action : Извлечь одно действие по его уникальному идентификатору из TeamRetro

• update_action : обновить существующее действие в TeamRetro, добавив новые данные, такие как название, дата выполнения, статус завершения, приоритет и назначенный пользователь.

• delete_action : Удалить существующее действие из TeamRetro по его идентификатору действия

Соглашения

• list_agreements : список соглашений от TeamRetro с дополнительной фильтрацией по тегам и идентификаторам команд, а также элементами управления пагинацией

• create_agreement : создать новое соглашение в TeamRetro, указав команду, к которой оно принадлежит, и его название.

• get_agreement : получить одно соглашение по его уникальному идентификатору

• update_agreement : обновить данные существующего соглашения, такие как его название или связанная с ним команда

• delete_agreement : Удалить существующее соглашение, указав его уникальный идентификатор

Проверки здоровья

• list_health_checks : список проверок работоспособности от TeamRetro с дополнительной фильтрацией по идентификаторам моделей работоспособности, тегам команд и идентификаторам команд, а также элементами управления пагинацией

• get_health_check : Извлечение одной проверки состояния здоровья по ее уникальному идентификатору с дополнительными атрибутами для включения

• delete_health_check : Удалить существующую проверку работоспособности, указав ее уникальный идентификатор.

Модели здоровья

• list_health_models : Список моделей здоровья от TeamRetro с элементами управления пагинацией

• get_health_model : получение одной модели здоровья по ее уникальному идентификатору

Ретроспективы

• list_retrospectives : список ретроспектив из TeamRetro с фильтрацией по тегам и идентификаторам команд, а также разбиением на страницы с использованием параметров смещения и ограничения.

• get_retrospective : получение подробной информации об одной ретроспективе по ее уникальному идентификатору

• delete_retrospective : Удалить существующую ретроспективу по ее идентификатору

Журнал изменений

Подробный список изменений и обновлений смотрите на CHANGELOG.md .