Provides Git repository management capabilities, including listing repositories and accessing repository information within Backlog projects.
Enables pull request management including creating, updating, listing pull requests and adding or updating comments on pull requests across repositories.
Отставание MCP-сервера
Сервер Model Context Protocol (MCP) для взаимодействия с API Backlog. Этот сервер предоставляет инструменты для управления проектами, проблемами, вики-страницами и многим другим в Backlog через агентов ИИ, таких как Claude Desktop / Cline / Cursor и т. д.
Функции
- Управление проектами (создание, чтение, обновление, удаление)
- Отслеживание проблем (создание, обновление, удаление, список)
- Управление вики-страницей
- Управление репозиторием Git
- Управление запросами на включение изменений (создание, обновление, составление списка, комментирование)
- Управление уведомлениями
- Управление списком наблюдения
- Выбор полей в стиле GraphQL для оптимизированных ответов
- Ограничение токенов для больших ответов
- Улучшенная обработка ошибок
- И другие интеграции API Backlog
Требования
- Докер
- Учетная запись Backlog с доступом к API
- API-ключ из вашего аккаунта Backlog
Установка
Вариант 1: Установка через Docker
Самый простой способ использования этого сервера MCP — через настройку MCP для Claude Desktop или Cline:
- Откройте настройки Claude Desktop или Cline.
- Перейдите в раздел конфигурации MCP.
- Добавьте следующую конфигурацию:
Замените your-domain.backlog.com
на ваш домен Backlog, а your-api-key
на ваш ключ API Backlog.
Расширенные параметры конфигурации
Это экспериментальный подход, а не стандартный способ уменьшения размера контекстного окна. Если у вас возникли проблемы с использованием этого MCP с любыми агентами ИИ, попробуйте изменить следующие настройки. Вы можете добавить дополнительные параметры для настройки поведения сервера:
MAX_TOKENS
: Максимальное количество токенов, разрешенных в ответах (по умолчанию: 50000)OPTIMIZE_RESPONSE
: включить выбор полей в стиле GraphQL для оптимизации размера ответа (по умолчанию: false)
Поддержание образа Docker в актуальном состоянии
По умолчанию Docker будет использовать локально кэшированный образ, если он уже был извлечен ранее. Чтобы убедиться, что вы всегда используете последнюю версию ghcr.io/nulab/backlog-mcp-server
, рассмотрите один из следующих методов:
Вариант 1: --pull always
(рекомендуется)
Если вы используете Docker 20.10 или более позднюю версию, вы можете изменить массив args
, включив в него флаг --pull always
:
Это гарантирует, что Docker всегда извлекает последний образ из GitHub Container Registry перед запуском.
Вариант 2: Извлечь последнее изображение вручную
Если ваша версия Docker не поддерживает --pull always, вы можете вручную загрузить последний образ перед запуском сервера:
Вариант 2: Ручная установка
- Клонируйте репозиторий:
- Установите зависимости:
- Создайте проект:
- Настройте свой json для использования в качестве MCP
Доступные инструменты
Сервер предоставляет следующие инструменты для взаимодействия с Backlog:
Космические инструменты
Название инструмента | Описание |
---|---|
get_space | Возвращает информацию о пространстве Backlog |
get_users | Возвращает список пользователей в области Backlog |
get_myself | Возвращает информацию об аутентифицированном пользователе |
get_priorities | Возвращает список приоритетов |
get_resolutions | Возвращает список решений проблем |
get_issue_types | Возвращает список типов проблем для проекта |
Инструменты проекта
Название инструмента | Описание |
---|---|
get_project_list | Возвращает список проектов |
add_project | Создает новый проект |
get_project | Возвращает информацию о конкретном проекте |
update_project | Обновляет существующий проект |
delete_project | Удаляет проект |
get_custom_fields | Возвращает список пользовательских полей для проекта |
Инструменты для выпуска
Название инструмента | Описание |
---|---|
get_issue | Возвращает информацию о конкретной проблеме |
get_issues | Возвращает список проблем |
count_issues | Возвращает количество проблем |
add_issue | Создает новую проблему в указанном проекте. |
update_issue | Обновляет существующую проблему |
delete_issue | Удаляет проблему |
Инструменты для комментирования
Название инструмента | Описание |
---|---|
get_issue_comments | Возвращает список комментариев к проблеме |
add_issue_comment | Добавляет комментарий к проблеме |
Вики-инструменты
Название инструмента | Описание |
---|---|
get_wiki_pages | Возвращает список страниц Wiki |
get_wikis_count | Возвращает количество вики-страниц в проекте |
get_wiki | Возвращает информацию о конкретной странице вики |
add_wiki | Создает новую вики-страницу |
Категория Инструменты
Название инструмента | Описание |
---|---|
get_categories | Возвращает список категорий для проекта |
Инструменты уведомлений
Название инструмента | Описание |
---|---|
get_notifications | Возвращает список уведомлений |
count_notifications | Возвращает количество уведомлений |
reset_unread_notification_count | Сбросить количество непрочитанных уведомлений |
mark_notification_as_read | Отметить уведомление как прочитанное |
Инструменты репозитория Git
Название инструмента | Описание |
---|---|
get_git_repositories | Возвращает список репозиториев Git для проекта |
get_git_repository | Возвращает информацию о конкретном репозитории Git |
Инструменты запроса на извлечение
Название инструмента | Описание |
---|---|
get_pull_requests | Возвращает список запросов на извлечение для репозитория |
get_pull_requests_count | Возвращает количество запросов на извлечение для репозитория. |
get_pull_request | Возвращает информацию о конкретном запросе на извлечение |
add_pull_request | Создает новый запрос на извлечение |
update_pull_request | Обновляет существующий запрос на извлечение |
get_pull_request_comments | Возвращает список комментариев для запроса на извлечение |
add_pull_request_comment | Добавляет комментарий к запросу на извлечение |
update_pull_request_comment | Обновляет комментарий к запросу на извлечение |
Инструменты для наблюдения
Название инструмента | Описание |
---|---|
get_watching_list_items | Возвращает список отслеживаемых элементов для пользователя |
get_watching_list_count | Возвращает количество отслеживаемых элементов для пользователя. |
Примеры использования
После настройки сервера MCP в агентах AI вы можете использовать инструменты непосредственно в своих разговорах. Вот несколько примеров:
Листинг проектов
Создание нового выпуска
Получение подробностей проекта
Работа с репозиториями Git
Управление запросами на извлечение
Просмотр элементов
Использование выбора поля
Если опция OPTIMIZE_RESPONSE
включена, вы можете указать, какие поля вы хотите извлечь, используя синтаксис в стиле GraphQL:
ИИ будет использовать выбор поля для оптимизации ответа:
Это сокращает размер ответа и время обработки, особенно для крупных объектов.
Расширенные функции
Оптимизация ответа
Выбор поля
При включении OPTIMIZE_RESPONSE=true
вы можете использовать синтаксис в стиле GraphQL для выбора определенных полей:
Это позволяет вам:
- Уменьшите размер ответа, запрашивая только необходимые поля.
- Сосредоточьтесь на конкретных точках данных
- Повышение производительности для больших ответов
Ограничение токенов
Большие ответы автоматически ограничиваются, чтобы не допустить превышения лимита токенов:
- Лимит по умолчанию: 50 000 токенов
- Настраивается через переменную среды
MAX_TOKENS
- Ответы, превышающие лимит, обрезаются сообщением.
i18n / Переопределение описаний
Вы можете переопределить описания инструментов, создав файл .backlog-mcp-serverrc.json
в своем домашнем каталоге .
Файл должен содержать объект JSON с названиями инструментов в качестве ключей и новыми описаниями в качестве значений.
Например:
При запуске сервера он определяет окончательное описание для каждого инструмента на основе следующего приоритета:
- Переменные среды (например,
BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION
) - Записи в
.backlog-mcp-serverrc.json
- Поддерживаемые форматы файлов конфигурации: .json, .yaml, .yml - Встроенные резервные значения (английский)
Пример конфигурации:
Экспорт текущих переводов
Вы можете экспортировать текущие переводы по умолчанию (включая любые переопределения), запустив двоичный файл с флагом --export-translations.
Это выведет все описания инструментов на стандартный вывод, включая любые сделанные вами настройки.
Пример:
или
Использование шаблона перевода на японский язык
Образец файла конфигурации на японском языке доступен по адресу:
Чтобы использовать его, скопируйте его в свой домашний каталог как .backlog-mcp-serverrc.json:
Затем вы можете отредактировать файл, чтобы настроить описания по мере необходимости.
Использование переменных среды
Кроме того, вы можете переопределить описания инструментов с помощью переменных среды.
Имена переменных среды основаны на ключах инструментов, имеют префикс BACKLOG_MCP_ и пишутся заглавными буквами.
Пример: Чтобы переопределить TOOL_ADD_ISSUE_COMMENT_DESCRIPTION:
Сервер загружает файл конфигурации синхронно при запуске.
Переменные среды всегда имеют приоритет над файлом конфигурации.
Разработка
Проведение тестов
Добавление новых инструментов
- Создайте новый файл в
src/tools/
по образцу существующих инструментов. - Создайте соответствующий тестовый файл
- Добавьте новый инструмент в
src/tools/tools.ts
- Создавайте и тестируйте свои изменения
Параметры командной строки
Сервер поддерживает несколько параметров командной строки:
--export-translations
: экспортировать все ключи и значения перевода--optimize-response
: включить выбор полей в стиле GraphQL--max-tokens=NUMBER
: Установить максимальный лимит токенов для ответов
Пример:
Лицензия
Данный проект лицензирован в соответствии с лицензией MIT .
Обратите внимание: этот инструмент предоставляется по лицензии MIT без каких-либо гарантий или официальной поддержки .
Используйте его на свой страх и риск, предварительно ознакомившись с его содержимым и определив его пригодность для ваших нужд.
Если у вас возникнут какие-либо проблемы, сообщите о них через GitHub Issues .
You must be authenticated.
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
Сервер протокола контекста модели, который позволяет Клоду взаимодействовать с инструментами управления проектами Backlog посредством интеграции API, что позволяет управлять проектами, проблемами, вики-страницами и другими ресурсами Backlog.
Related MCP Servers
- -securityAlicense-qualityA Model Context Protocol server that allows Claude to interact with Linear's API for managing teams, issues, projects, and cycles.Last updated -181TypeScriptMIT License
- -securityAlicense-qualityA Model Context Protocol server that enables Claude to interact with the ConnectWise Manage API to perform operations like retrieving, creating, updating, and deleting tickets, companies, contacts, and other entities.Last updated -JavaScriptMIT License
- -securityFlicense-qualityIntegrates Backlog project management with Claude via Model Context Protocol, enabling access to projects, issues, and wiki pages through natural language interactions.Last updated -TypeScript
- -securityFlicense-qualityA Model Context Protocol server that enables interaction with Shortcut (formerly Clubhouse) project management tool, allowing users to view and search projects, stories, epics, and objectives, as well as create new items through natural language.Last updated -3Python