Skip to main content
Glama
Sign In
deenesjakoruzh

Backlog MCP Server

by nulab
npmGitHub
TypeScript
MIT License
53
40
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue
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.

Backlog MCP-Server

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

Ein Model Context Protocol (MCP)-Server für die Interaktion mit der Backlog-API. Dieser Server bietet Tools zur Verwaltung von Projekten, Problemen, Wiki-Seiten und mehr im Backlog über KI-Agenten wie Claude Desktop, Cline, Cursor usw.

Merkmale

  • Projektverwaltung (Erstellen, Lesen, Aktualisieren, Löschen)
  • Problemverfolgung (Erstellen, Aktualisieren, Löschen, Auflisten)
  • Wiki-Seitenverwaltung
  • Git-Repository-Verwaltung
  • Pull Request-Verwaltung (Erstellen, Aktualisieren, Auflisten, Kommentieren)
  • Benachrichtigungsverwaltung
  • Beobachtungslistenverwaltung
  • Feldauswahl im GraphQL-Stil für optimierte Antworten
  • Token-Begrenzung für große Antworten
  • Verbesserte Fehlerbehandlung
  • Und weitere Backlog-API-Integrationen

Anforderungen

  • Docker
  • Ein Backlog-Konto mit API-Zugriff
  • API-Schlüssel aus Ihrem Backlog-Konto

Installation

Option 1: Installation über Docker

Die einfachste Möglichkeit, diesen MCP-Server zu verwenden, ist die MCP-Konfiguration für Claude Desktop oder Cline:

  1. Öffnen Sie die Claude Desktop- oder Cline-Einstellungen
  2. Navigieren Sie zum MCP-Konfigurationsbereich
  3. Fügen Sie die folgende Konfiguration hinzu:
{ "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" } } } }

Ersetzen Sie your-domain.backlog.com durch Ihre Backlog-Domäne und your-api-key durch Ihren Backlog-API-Schlüssel.

Erweiterte Konfigurationsoptionen

Dies ist ein experimenteller Ansatz und nicht die übliche Methode zur Verkleinerung des Kontextfensters. Sollten Sie Probleme mit der Verwendung dieses MCP mit KI-Agenten haben, versuchen Sie bitte, die folgenden Einstellungen anzupassen. Sie können zusätzliche Optionen hinzufügen, um das Serververhalten anzupassen:

{ "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 : Maximale Anzahl an Token, die in Antworten zulässig sind (Standard: 50000)
  • OPTIMIZE_RESPONSE : Aktivieren Sie die Feldauswahl im GraphQL-Stil, um die Antwortgröße zu optimieren (Standard: „false“)

Das Docker-Image auf dem neuesten Stand halten

Standardmäßig verwendet Docker ein lokal zwischengespeichertes Image, wenn es bereits zuvor abgerufen wurde. Um sicherzustellen, dass Sie immer die neueste Version von ghcr.io/nulab/backlog-mcp-server verwenden, ziehen Sie eine der folgenden Methoden in Betracht:

Option 1: --pull always verwenden (empfohlen)

Wenn Sie Docker 20.10 oder höher verwenden, können Sie das args Array so ändern, dass es das Flag --pull always enthält:

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

Dadurch wird sichergestellt, dass Docker vor der Ausführung immer das neueste Image aus der GitHub Container Registry abruft.

Option 2: Manuelles Herunterladen des neuesten Images

Wenn Ihre Docker-Version --pull nicht immer unterstützt, können Sie das neueste Image manuell abrufen, bevor Sie den Server ausführen:

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

Option 2: Manuelle Installation

  1. Klonen Sie das Repository:
    git clone https://github.com/nulab/backlog-mcp-server.git cd backlog-mcp-server
  2. Installieren Sie Abhängigkeiten:
    npm install
  3. Erstellen Sie das Projekt:
    npm run build
  4. Legen Sie Ihr JSON zur Verwendung als MCP fest
{ "mcpServers": { "backlog": { "command": "node", "args": [ "your-repository-location/build/index.js" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

Verfügbare Tools

Der Server bietet die folgenden Tools zur Interaktion mit Backlog:

Weltraumwerkzeuge

WerkzeugnameBeschreibung
get_spaceGibt Informationen über den Backlog-Speicherplatz zurück
get_usersGibt eine Liste der Benutzer im Backlog-Bereich zurück
get_myselfGibt Informationen über den authentifizierten Benutzer zurück
get_prioritiesPrioritätenliste der Rücksendungen
get_resolutionsGibt eine Liste mit Problemlösungen zurück
get_issue_typesGibt eine Liste der Problemtypen für ein Projekt zurück

Projekt-Tools

WerkzeugnameBeschreibung
get_project_listGibt eine Liste der Projekte zurück
add_projectErstellt ein neues Projekt
get_projectGibt Informationen zu einem bestimmten Projekt zurück
update_projectAktualisiert ein vorhandenes Projekt
delete_projectLöscht ein Projekt
get_custom_fieldsGibt eine Liste benutzerdefinierter Felder für ein Projekt zurück

Ausgabetools

WerkzeugnameBeschreibung
get_issueGibt Informationen zu einem bestimmten Problem zurück
get_issuesGibt eine Liste der Probleme zurück
count_issuesGibt die Anzahl der Probleme zurück
add_issueErstellt ein neues Problem im angegebenen Projekt
update_issueAktualisiert ein vorhandenes Problem
delete_issueLöscht ein Problem

Kommentartools

WerkzeugnameBeschreibung
get_issue_commentsGibt eine Liste mit Kommentaren zu einem Problem zurück
add_issue_commentFügt einem Problem einen Kommentar hinzu

Wiki-Tools

WerkzeugnameBeschreibung
get_wiki_pagesGibt eine Liste der Wiki-Seiten zurück
get_wikis_countGibt die Anzahl der Wiki-Seiten in einem Projekt zurück
get_wikiGibt Informationen zu einer bestimmten Wiki-Seite zurück
add_wikiErstellt eine neue Wiki-Seite

Kategorie Werkzeuge

WerkzeugnameBeschreibung
get_categoriesGibt eine Liste der Kategorien für ein Projekt zurück

Benachrichtigungstools

WerkzeugnameBeschreibung
get_notificationsGibt eine Liste der Benachrichtigungen zurück
count_notificationsGibt die Anzahl der Benachrichtigungen zurück
reset_unread_notification_countAnzahl ungelesener Benachrichtigungen zurücksetzen
mark_notification_as_readEine Benachrichtigung als gelesen markieren

Git-Repository-Tools

WerkzeugnameBeschreibung
get_git_repositoriesGibt eine Liste der Git-Repositorys für ein Projekt zurück
get_git_repositoryGibt Informationen zu einem bestimmten Git-Repository zurück

Pull Request-Tools

WerkzeugnameBeschreibung
get_pull_requestsGibt eine Liste der Pull Requests für ein Repository zurück
get_pull_requests_countGibt die Anzahl der Pull Requests für ein Repository zurück
get_pull_requestGibt Informationen zu einem bestimmten Pull Request zurück
add_pull_requestErstellt einen neuen Pull Request
update_pull_requestAktualisiert eine vorhandene Pull-Anforderung
get_pull_request_commentsGibt eine Liste mit Kommentaren für eine Pull-Anfrage zurück
add_pull_request_commentFügt einem Pull Request einen Kommentar hinzu
update_pull_request_commentAktualisiert einen Kommentar zu einer Pull-Anfrage

Überwachungstools

WerkzeugnameBeschreibung
get_watching_list_itemsGibt eine Liste der beobachteten Elemente für einen Benutzer zurück
get_watching_list_countGibt die Anzahl der von einem Benutzer beobachteten Elemente zurück

Anwendungsbeispiele

Sobald der MCP-Server in KI-Agenten konfiguriert ist, können Sie die Tools direkt in Ihren Konversationen verwenden. Hier sind einige Beispiele:

Projekte auflisten

Could you list all my Backlog projects?

Erstellen eines neuen Problems

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

Projektdetails abrufen

Show me the details of the PROJECT-KEY project

Arbeiten mit Git-Repositorys

List all Git repositories in the PROJECT-KEY project

Verwalten von Pull Requests

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

Beobachtete Artikel

Show me all items I'm watching

Verwenden der Feldauswahl

Wenn die Option OPTIMIZE_RESPONSE aktiviert ist, können Sie mit einer Syntax im GraphQL-Stil angeben, welche Felder Sie abrufen möchten:

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

Die KI nutzt die Feldauswahl, um die Antwort zu optimieren:

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

Dies reduziert die Antwortgröße und Verarbeitungszeit, insbesondere bei großen Objekten.

Erweiterte Funktionen

Reaktionsoptimierung

Feldauswahl

Wenn OPTIMIZE_RESPONSE=true aktiviert ist, können Sie eine Syntax im GraphQL-Stil verwenden, um bestimmte Felder auszuwählen:

{ id name description users { id name } }

Dies ermöglicht Ihnen:

  • Reduzieren Sie die Antwortgröße, indem Sie nur die erforderlichen Felder anfordern
  • Konzentrieren Sie sich auf bestimmte Datenpunkte
  • Verbessern der Leistung bei großen Antworten
Token-Begrenzung

Um ein Überschreiten der Token-Grenzen zu verhindern, werden große Antworten automatisch begrenzt:

  • Standardlimit: 50.000 Token
  • Konfigurierbar über die Umgebungsvariable MAX_TOKENS
  • Antworten, die das Limit überschreiten, werden mit einer Nachricht abgeschnitten

i18n / Überschreiben von Beschreibungen

Sie können die Beschreibungen der Tools überschreiben, indem Sie in Ihrem Home-Verzeichnis eine Datei .backlog-mcp-serverrc.json erstellen.

Die Datei sollte ein JSON-Objekt mit den Toolnamen als Schlüssel und den neuen Beschreibungen als Werte enthalten.
Zum Beispiel:

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

Wenn der Server startet, bestimmt er die endgültige Beschreibung für jedes Tool basierend auf der folgenden Priorität:

  1. Umgebungsvariablen (z. B. BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION )
  2. Einträge in .backlog-mcp-serverrc.json – Unterstützte Konfigurationsdateiformate: .json, .yaml, .yml
  3. Integrierte Fallbackwerte (Englisch)

Beispielkonfiguration:

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

Aktuelle Übersetzungen exportieren

Sie können die aktuellen Standardübersetzungen (einschließlich aller Überschreibungen) exportieren, indem Sie die Binärdatei mit dem Flag --export-translations ausführen.

Dadurch werden alle Toolbeschreibungen, einschließlich aller von Ihnen vorgenommenen Anpassungen, auf die Standardausgabe gedruckt.

Beispiel:

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

oder

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

Verwenden einer japanischen Übersetzungsvorlage

Eine japanische Beispielkonfigurationsdatei finden Sie unter:

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

Um es zu verwenden, kopieren Sie es als .backlog-mcp-serverrc.json in Ihr Home-Verzeichnis:

Sie können die Datei dann bearbeiten, um die Beschreibungen nach Bedarf anzupassen.

Verwenden von Umgebungsvariablen

Alternativ können Sie Toolbeschreibungen über Umgebungsvariablen überschreiben.

Die Namen der Umgebungsvariablen basieren auf den Tool-Schlüsseln, haben das Präfix BACKLOG_MCP_ und werden in Großbuchstaben geschrieben.

Beispiel: So überschreiben Sie 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" } } } }

Der Server lädt die Konfigurationsdatei synchron beim Start.

Umgebungsvariablen haben immer Vorrang vor der Konfigurationsdatei.

Entwicklung

Ausführen von Tests

npm test

Neue Tools hinzufügen

  1. Erstellen Sie eine neue Datei in src/tools/ nach dem Muster vorhandener Tools
  2. Erstellen Sie eine entsprechende Testdatei
  3. Fügen Sie das neue Tool zu src/tools/tools.ts hinzu
  4. Erstellen und testen Sie Ihre Änderungen

Befehlszeilenoptionen

Der Server unterstützt mehrere Befehlszeilenoptionen:

  • --export-translations : Alle Übersetzungsschlüssel und -werte exportieren
  • --optimize-response : Feldauswahl im GraphQL-Stil aktivieren
  • --max-tokens=NUMBER : Maximales Token-Limit für Antworten festlegen

Beispiel:

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

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.

Bitte beachten Sie: Dieses Tool wird unter der MIT-Lizenz ohne jegliche Garantie oder offiziellen Support bereitgestellt.
Verwenden Sie es auf eigene Gefahr, nachdem Sie den Inhalt geprüft und festgestellt haben, ob es für Ihre Anforderungen geeignet ist.
Wenn Sie auf Probleme stoßen, melden Sie diese bitte über 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.

Tools

View all tools

Ein Model Context Protocol-Server, der Claude die Interaktion mit Backlog-Projektmanagement-Tools über API-Integration ermöglicht und so die Verwaltung von Projekten, Problemen, Wiki-Seiten und anderen Backlog-Ressourcen ermöglicht.

  1. Merkmale
    1. Anforderungen
      1. Installation
        1. Option 1: Installation über Docker
        2. Das Docker-Image auf dem neuesten Stand halten
        3. Option 2: Manuelle Installation
      2. Verfügbare Tools
        1. Weltraumwerkzeuge
        2. Projekt-Tools
        3. Ausgabetools
        4. Kommentartools
        5. Wiki-Tools
        6. Kategorie Werkzeuge
        7. Benachrichtigungstools
        8. Git-Repository-Tools
        9. Pull Request-Tools
        10. Überwachungstools
      3. Anwendungsbeispiele
        1. Projekte auflisten
        2. Erstellen eines neuen Problems
        3. Projektdetails abrufen
        4. Arbeiten mit Git-Repositorys
        5. Verwalten von Pull Requests
        6. Beobachtete Artikel
        7. Verwenden der Feldauswahl
      4. Erweiterte Funktionen
        1. Reaktionsoptimierung
        2. i18n / Überschreiben von Beschreibungen
        3. Aktuelle Übersetzungen exportieren
        4. Verwenden einer japanischen Übersetzungsvorlage
        5. Verwenden von Umgebungsvariablen
      5. Entwicklung
        1. Ausführen von Tests
        2. Neue Tools hinzufügen
        3. Befehlszeilenoptionen
      6. Lizenz

        Related MCP Servers

        • Linear MCP Server

          cpropster
          -
          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

        • ConnectWise Manage MCP Server

          ethangillani
          -
          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

        • Backlog MCP Server

          katsuhirohonda
          -
          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

        • Shortcut MCP Server

          zekus
          -
          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

        Appeared in Searches

        New 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