Backlog MCP Server

Integrations
  • 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:

  1. Откройте настройки Claude Desktop или Cline.
  2. Перейдите в раздел конфигурации MCP.
  3. Добавьте следующую конфигурацию:
{ "mcpServers": { "backlog": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "BACKLOG_DOMAIN", "-e", "BACKLOG_API_KEY", "ghcr.io/nulab/backlog-mcp-server" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

Замените your-domain.backlog.com на ваш домен Backlog, а your-api-key на ваш ключ API Backlog.

Расширенные параметры конфигурации

Это экспериментальный подход, а не стандартный способ уменьшения размера контекстного окна. Если у вас возникли проблемы с использованием этого MCP с любыми агентами ИИ, попробуйте изменить следующие настройки. Вы можете добавить дополнительные параметры для настройки поведения сервера:

{ "mcpServers": { "backlog": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "BACKLOG_DOMAIN", "-e", "BACKLOG_API_KEY", "-e", "MAX_TOKENS", "-e", "OPTIMIZE_RESPONSE", "ghcr.io/nulab/backlog-mcp-server" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key", "MAX_TOKENS": "10000", "OPTIMIZE_RESPONSE": "true" } } } }
  • MAX_TOKENS : Максимальное количество токенов, разрешенных в ответах (по умолчанию: 50000)
  • OPTIMIZE_RESPONSE : включить выбор полей в стиле GraphQL для оптимизации размера ответа (по умолчанию: false)

Поддержание образа Docker в актуальном состоянии

По умолчанию Docker будет использовать локально кэшированный образ, если он уже был извлечен ранее. Чтобы убедиться, что вы всегда используете последнюю версию ghcr.io/nulab/backlog-mcp-server , рассмотрите один из следующих методов:

Вариант 1: --pull always (рекомендуется)

Если вы используете Docker 20.10 или более позднюю версию, вы можете изменить массив args , включив в него флаг --pull always :

{ "mcpServers": { "backlog": { "command": "docker", "args": [ "run", "--pull", "always", "-i", "--rm", "-e", "BACKLOG_DOMAIN", "-e", "BACKLOG_API_KEY", "ghcr.io/nulab/backlog-mcp-server" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

Это гарантирует, что Docker всегда извлекает последний образ из GitHub Container Registry перед запуском.

Вариант 2: Извлечь последнее изображение вручную

Если ваша версия Docker не поддерживает --pull always, вы можете вручную загрузить последний образ перед запуском сервера:

docker pull ghcr.io/nulab/backlog-mcp-server:latest

Вариант 2: Ручная установка

  1. Клонируйте репозиторий:
    git clone https://github.com/nulab/backlog-mcp-server.git cd backlog-mcp-server
  2. Установите зависимости:
    npm install
  3. Создайте проект:
    npm run build
  4. Настройте свой json для использования в качестве MCP
{ "mcpServers": { "backlog": { "command": "node", "args": [ "your-repository-location/build/index.js" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

Доступные инструменты

Сервер предоставляет следующие инструменты для взаимодействия с 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 вы можете использовать инструменты непосредственно в своих разговорах. Вот несколько примеров:

Листинг проектов

Could you list all my Backlog projects?

Создание нового выпуска

Create a new bug issue in the PROJECT-KEY project with high priority titled "Fix login page error"

Получение подробностей проекта

Show me the details of the PROJECT-KEY project

Работа с репозиториями Git

List all Git repositories in the PROJECT-KEY project

Управление запросами на извлечение

Show me all open pull requests in the repository "repo-name" of PROJECT-KEY project
Create a new pull request from branch "feature/new-feature" to "main" in the repository "repo-name" of PROJECT-KEY project

Просмотр элементов

Show me all items I'm watching

Использование выбора поля

Если опция OPTIMIZE_RESPONSE включена, вы можете указать, какие поля вы хотите извлечь, используя синтаксис в стиле GraphQL:

Show me the details of the PROJECT-KEY project, but only include the name, key, and description fields

ИИ будет использовать выбор поля для оптимизации ответа:

get_project(projectIdOrKey: "PROJECT-KEY", fields: "{ name key description }")

Это сокращает размер ответа и время обработки, особенно для крупных объектов.

Расширенные функции

Оптимизация ответа

Выбор поля

При включении OPTIMIZE_RESPONSE=true вы можете использовать синтаксис в стиле GraphQL для выбора определенных полей:

{ id name description users { id name } }

Это позволяет вам:

  • Уменьшите размер ответа, запрашивая только необходимые поля.
  • Сосредоточьтесь на конкретных точках данных
  • Повышение производительности для больших ответов
Ограничение токенов

Большие ответы автоматически ограничиваются, чтобы не допустить превышения лимита токенов:

  • Лимит по умолчанию: 50 000 токенов
  • Настраивается через переменную среды MAX_TOKENS
  • Ответы, превышающие лимит, обрезаются сообщением.

i18n / Переопределение описаний

Вы можете переопределить описания инструментов, создав файл .backlog-mcp-serverrc.json в своем домашнем каталоге .

Файл должен содержать объект JSON с названиями инструментов в качестве ключей и новыми описаниями в качестве значений.
Например:

{ "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "An alternative description", "TOOL_CREATE_PROJECT_DESCRIPTION": "Create a new project in Backlog" }

При запуске сервера он определяет окончательное описание для каждого инструмента на основе следующего приоритета:

  1. Переменные среды (например, BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION )
  2. Записи в .backlog-mcp-serverrc.json - Поддерживаемые форматы файлов конфигурации: .json, .yaml, .yml
  3. Встроенные резервные значения (английский)

Пример конфигурации:

{ "mcpServers": { "backlog": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "BACKLOG_DOMAIN", "-e", "BACKLOG_API_KEY", "-v", "/yourcurrentdir/.backlog-mcp-serverrc.json:/root/.backlog-mcp-serverrc.json:ro", "ghcr.io/nulab/backlog-mcp-server" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

Экспорт текущих переводов

Вы можете экспортировать текущие переводы по умолчанию (включая любые переопределения), запустив двоичный файл с флагом --export-translations.

Это выведет все описания инструментов на стандартный вывод, включая любые сделанные вами настройки.

Пример:

docker run -i --rm ghcr.io/nulab/backlog-mcp-server node build/index.js --export-translations

или

npx github:nulab/backlog-mcp-server --export-translations

Использование шаблона перевода на японский язык

Образец файла конфигурации на японском языке доступен по адресу:

translationConfig/.backlog-mcp-serverrc.json.example

Чтобы использовать его, скопируйте его в свой домашний каталог как .backlog-mcp-serverrc.json:

Затем вы можете отредактировать файл, чтобы настроить описания по мере необходимости.

Использование переменных среды

Кроме того, вы можете переопределить описания инструментов с помощью переменных среды.

Имена переменных среды основаны на ключах инструментов, имеют префикс BACKLOG_MCP_ и пишутся заглавными буквами.

Пример: Чтобы переопределить TOOL_ADD_ISSUE_COMMENT_DESCRIPTION:

{ "mcpServers": { "backlog": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "BACKLOG_DOMAIN", "-e", "BACKLOG_API_KEY", "-e", "BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION" "ghcr.io/nulab/backlog-mcp-server" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key", "BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "An alternative description" } } } }

Сервер загружает файл конфигурации синхронно при запуске.

Переменные среды всегда имеют приоритет над файлом конфигурации.

Разработка

Проведение тестов

npm test

Добавление новых инструментов

  1. Создайте новый файл в src/tools/ по образцу существующих инструментов.
  2. Создайте соответствующий тестовый файл
  3. Добавьте новый инструмент в src/tools/tools.ts
  4. Создавайте и тестируйте свои изменения

Параметры командной строки

Сервер поддерживает несколько параметров командной строки:

  • --export-translations : экспортировать все ключи и значения перевода
  • --optimize-response : включить выбор полей в стиле GraphQL
  • --max-tokens=NUMBER : Установить максимальный лимит токенов для ответов

Пример:

node build/index.js --optimize-response --max-tokens=100000

Лицензия

Данный проект лицензирован в соответствии с лицензией MIT .

Обратите внимание: этот инструмент предоставляется по лицензии MIT без каких-либо гарантий или официальной поддержки .
Используйте его на свой страх и риск, предварительно ознакомившись с его содержимым и определив его пригодность для ваших нужд.
Если у вас возникнут какие-либо проблемы, сообщите о них через GitHub Issues .

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

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.

Сервер протокола контекста модели, который позволяет Клоду взаимодействовать с инструментами управления проектами Backlog посредством интеграции API, что позволяет управлять проектами, проблемами, вики-страницами и другими ресурсами Backlog.

  1. Функции
    1. Требования
      1. Установка
        1. Вариант 1: Установка через Docker
        2. Поддержание образа Docker в актуальном состоянии
        3. Вариант 2: Ручная установка
      2. Доступные инструменты
        1. Космические инструменты
        2. Инструменты проекта
        3. Инструменты для выпуска
        4. Инструменты для комментирования
        5. Вики-инструменты
        6. Категория Инструменты
        7. Инструменты уведомлений
        8. Инструменты репозитория Git
        9. Инструменты запроса на извлечение
        10. Инструменты для наблюдения
      3. Примеры использования
        1. Листинг проектов
        2. Создание нового выпуска
        3. Получение подробностей проекта
        4. Работа с репозиториями Git
        5. Управление запросами на извлечение
        6. Просмотр элементов
        7. Использование выбора поля
      4. Расширенные функции
        1. Оптимизация ответа
        2. i18n / Переопределение описаний
        3. Экспорт текущих переводов
        4. Использование шаблона перевода на японский язык
        5. Использование переменных среды
      5. Разработка
        1. Проведение тестов
        2. Добавление новых инструментов
        3. Параметры командной строки
      6. Лицензия

        Related MCP Servers

        • -
          security
          A
          license
          -
          quality
          A Model Context Protocol server that allows Claude to interact with Linear's API for managing teams, issues, projects, and cycles.
          Last updated -
          18
          1
          TypeScript
          MIT License
        • -
          security
          A
          license
          -
          quality
          A 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 -
          JavaScript
          MIT License
          • Apple
        • -
          security
          F
          license
          -
          quality
          Integrates Backlog project management with Claude via Model Context Protocol, enabling access to projects, issues, and wiki pages through natural language interactions.
          Last updated -
          TypeScript
        • -
          security
          F
          license
          -
          quality
          A 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 -
          3
          Python
          • Apple

        View all related MCP servers

        MCP directory API

        We provide all the information about MCP servers via our MCP API.

        curl -X GET 'https://glama.ai/api/mcp/v1/servers/nulab/backlog-mcp-server'

        If you have feedback or need assistance with the MCP directory API, please join our Discord server