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.

Servidor MCP atrasado

📘 日本語でのご利用ガイド

Un servidor de Protocolo de Contexto de Modelo (MCP) para interactuar con la API de Backlog. Este servidor proporciona herramientas para gestionar proyectos, incidencias, páginas wiki y más en Backlog mediante agentes de IA como Claude Desktop, Cline, Cursor, etc.

Características

  • Gestión de proyectos (crear, leer, actualizar, eliminar)
  • Seguimiento de problemas (crear, actualizar, eliminar, listar)
  • Gestión de páginas wiki
  • Gestión del repositorio Git
  • Gestión de solicitudes de extracción (crear, actualizar, listar, comentar)
  • Gestión de notificaciones
  • Gestión de listas de vigilancia
  • Y más integraciones de API Backlog

Requisitos

  • Estibador
  • Una cuenta Backlog con acceso a la API
  • Clave API de su cuenta Backlog

Instalación

Opción 1: Instalar mediante Docker

La forma más sencilla de utilizar este servidor MCP es a través de la configuración de MCP para Claude Desktop o Cline:

  1. Abra Claude Desktop o la configuración de Cline
  2. Navegue a la sección de configuración de MCP
  3. Agregue la siguiente configuración:
{ "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" } } } }

Reemplace your-domain.backlog.com con su dominio de Backlog y your-api-key con su clave API de Backlog.

Opción 2: Instalación manual

  1. Clonar el repositorio:
    git clone https://github.com/nulab/backlog-mcp-server.git cd backlog-mcp-server
  2. Instalar dependencias:
    npm install
  3. Construir el proyecto:
    npm run build
  4. Configura tu json para usarlo como MCP
{ "mcpServers": { "backlog": { "command": "node", "args": [ "your-repojitory-location/build/index.js" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

Herramientas disponibles

El servidor proporciona las siguientes herramientas para interactuar con Backlog:

Herramientas espaciales

Nombre de la herramientaDescripción
get_spaceDevuelve información sobre el espacio Backlog
get_usersDevuelve la lista de usuarios en el espacio Backlog
get_myselfDevuelve información sobre el usuario autenticado
get_prioritiesDevuelve la lista de prioridades
get_resolutionsDevuelve una lista de resoluciones de problemas
get_issue_typesDevuelve una lista de tipos de problemas para un proyecto

Herramientas del proyecto

Nombre de la herramientaDescripción
get_project_listDevuelve la lista de proyectos
add_projectCrea un nuevo proyecto
get_projectDevuelve información sobre un proyecto específico
update_projectActualiza un proyecto existente
delete_projectElimina un proyecto

Herramientas de problemas

Nombre de la herramientaDescripción
get_issueDevuelve información sobre un problema específico
get_issuesDevuelve la lista de problemas
count_issuesDevuelve el recuento de problemas
add_issueCrea un nuevo problema en el proyecto especificado
update_issueActualiza un problema existente
delete_issueElimina un problema

Herramientas para comentarios

Nombre de la herramientaDescripción
get_issue_commentsDevuelve una lista de comentarios para un problema
add_issue_commentAñade un comentario a un problema.

Herramientas Wiki

Nombre de la herramientaDescripción
get_wiki_pagesDevuelve la lista de páginas Wiki
get_wikis_countDevuelve el recuento de páginas wiki en un proyecto
get_wikiDevuelve información sobre una página wiki específica
add_wikiCrea una nueva página wiki

Herramientas de categoría

Nombre de la herramientaDescripción
get_categoriesDevuelve una lista de categorías para un proyecto

Herramientas de notificación

Nombre de la herramientaDescripción
get_notificationsDevuelve la lista de notificaciones
count_notificationsDevuelve el recuento de notificaciones
reset_unread_notification_countRestablecer el recuento de notificaciones no leídas
mark_notification_as_readMarcar una notificación como leída

Herramientas del repositorio Git

Nombre de la herramientaDescripción
get_git_repositoriesDevuelve una lista de repositorios Git para un proyecto
get_git_repositoryDevuelve información sobre un repositorio Git específico

Herramientas de solicitud de extracción

Nombre de la herramientaDescripción
get_pull_requestsDevuelve la lista de solicitudes de extracción para un repositorio
get_pull_requests_countDevuelve el recuento de solicitudes de extracción para un repositorio
get_pull_requestDevuelve información sobre una solicitud de extracción específica
add_pull_requestCrea una nueva solicitud de extracción
update_pull_requestActualiza una solicitud de extracción existente
get_pull_request_commentsDevuelve la lista de comentarios para una solicitud de extracción
add_pull_request_commentAgrega un comentario a una solicitud de extracción
update_pull_request_commentActualiza un comentario en una solicitud de extracción

Herramientas de observación

Nombre de la herramientaDescripción
get_watching_list_itemsDevuelve una lista de elementos observados por un usuario
get_watching_list_countDevuelve el recuento de elementos vistos por un usuario

Ejemplos de uso

Una vez configurado el servidor MCP en los agentes de IA, podrá usar las herramientas directamente en sus conversaciones. A continuación, se muestran algunos ejemplos:

Listado de proyectos

Could you list all my Backlog projects?

Crear un nuevo problema

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

Obtener detalles del proyecto

Show me the details of the PROJECT-KEY project

Trabajar con repositorios Git

List all Git repositories in the PROJECT-KEY project

Gestión de solicitudes de extracción

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

Observando objetos

Show me all items I'm watching

i18n / Descripciones de reemplazo

Puede anular las descripciones de las herramientas creando un archivo .backlog-mcp-serverrc.json en su directorio de inicio .

El archivo debe contener un objeto JSON con los nombres de las herramientas como claves y las nuevas descripciones como valores.
Por ejemplo:

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

Cuando se inicia el servidor, determina la descripción final de cada herramienta según la siguiente prioridad:

  1. Variables de entorno (por ejemplo, BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION )
  2. Entradas en .backlog-mcp-serverrc.json : formatos de archivos de configuración admitidos: .json, .yaml, .yml
  3. Valores de respaldo integrados (en inglés)

Configuración de muestra:

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

Exportación de traducciones actuales

Puede exportar las traducciones predeterminadas actuales (incluida cualquier anulación) ejecutando el binario con el indicador --export-translations.

Esto imprimirá todas las descripciones de las herramientas en la salida estándar, incluidas todas las personalizaciones que haya realizado.

Ejemplo:

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

o

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

Uso de una plantilla de traducción al japonés

Se proporciona un archivo de configuración japonés de muestra en:

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

Para usarlo, cópielo a su directorio de inicio como .backlog-mcp-serverrc.json:

Luego puede editar el archivo para personalizar las descripciones según sea necesario.

Uso de variables de entorno

Alternativamente, puede anular las descripciones de herramientas a través de variables de entorno.

Los nombres de las variables de entorno se basan en las claves de herramientas, tienen el prefijo BACKLOG_MCP_ y están escritos en mayúsculas.

Ejemplo: Para anular 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" } } } }

El servidor carga el archivo de configuración sincrónicamente al iniciarse.

Las variables de entorno siempre tienen prioridad sobre el archivo de configuración.

Desarrollo

Ejecución de pruebas

npm test

Agregar nuevas herramientas

  1. Crea un nuevo archivo en src/tools/ siguiendo el patrón de las herramientas existentes
  2. Crear un archivo de prueba correspondiente
  3. Agregue la nueva herramienta a src/tools/tools.ts
  4. Construya y pruebe sus cambios

Licencia

Este proyecto está licenciado bajo la licencia MIT .

Tenga en cuenta: esta herramienta se proporciona bajo la licencia MIT sin ninguna garantía ni soporte oficial .
Úselo bajo su propio riesgo después de revisar el contenido y determinar su idoneidad para sus necesidades.
Si encuentra algún problema, infórmelo a través de Problemas de GitHub .

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.

Un servidor de protocolo de contexto de modelo que permite a Claude interactuar con las herramientas de gestión de proyectos Backlog a través de la integración de API, lo que permite la gestión de proyectos, problemas, páginas wiki y otros recursos Backlog.

  1. Features
    1. Requirements
      1. Installation
        1. Option 1: Install via Docker
        2. Option 2: Manual Installation
      2. Available Tools
        1. Space Tools
        2. Project Tools
        3. Issue Tools
        4. Comment Tools
        5. Wiki Tools
        6. Category Tools
        7. Notification Tools
        8. Git Repository Tools
        9. Pull Request Tools
        10. Watching Tools
      3. Usage Examples
        1. Listing Projects
        2. Creating a New Issue
        3. Getting Project Details
        4. Working with Git Repositories
        5. Managing Pull Requests
        6. Watching Items
      4. i18n / Overriding Descriptions
        1. Exporting Current Translations
        2. Using a Japanese Translation Template
        3. Using Environment Variables
      5. Development
        1. Running Tests
        2. Adding New Tools
      6. License
        ID: lktnbgdbjl