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サーバー

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

Backlog APIと連携するためのモデルコンテキストプロトコル(MCP)サーバー。このサーバーは、Claude Desktop、Cline、CursorなどのAIエージェントを通じて、Backlog内のプロジェクト、課題、Wikiページなどを管理するためのツールを提供します。

特徴

  • プロジェクト管理(作成、読み取り、更新、削除)
  • 問題追跡(作成、更新、削除、リスト)
  • Wikiページ管理
  • Gitリポジトリ管理
  • プルリクエスト管理(作成、更新、リスト、コメント)
  • 通知管理
  • ウォッチリスト管理
  • さらにBacklog APIとの統合

要件

  • ドッカー
  • APIアクセス可能なBacklogアカウント
  • BacklogアカウントのAPIキー

インストール

オプション1: Docker経由でインストールする

この MCP サーバーを使用する最も簡単な方法は、Claude Desktop または Cline の MCP 構成を使用することです。

  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 Backlog API キーに置き換えます。

オプション2: 手動インストール

  1. リポジトリをクローンします。
    git clone https://github.com/nulab/backlog-mcp-server.git cd backlog-mcp-server
  2. 依存関係をインストールします:
    npm install
  3. プロジェクトをビルドします。
    npm run build
  4. MCPとして使用するJSONを設定します
{ "mcpServers": { "backlog": { "command": "node", "args": [ "your-repojitory-location/build/index.js" ], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } }

利用可能なツール

サーバーは、Backlog と対話するための次のツールを提供します。

宇宙ツール

ツール名説明
get_spaceバックログスペースに関する情報を返します
get_usersBacklogスペース内のユーザーのリストを返します
get_myself認証されたユーザーに関する情報を返します
get_priorities優先順位のリストを返します
get_resolutions問題解決のリストを返します
get_issue_typesプロジェクトの問題タイプのリストを返します

プロジェクトツール

ツール名説明
get_project_listプロジェクトのリストを返します
add_project新しいプロジェクトを作成します
get_project特定のプロジェクトに関する情報を返します
update_project既存のプロジェクトを更新する
delete_projectプロジェクトを削除します

問題ツール

ツール名説明
get_issue特定の問題に関する情報を返します
get_issues問題のリストを返します
count_issues問題の数を返す
add_issue指定されたプロジェクトに新しい問題を作成します
update_issue既存の問題を更新します
delete_issue問題を削除します

コメントツール

ツール名説明
get_issue_comments問題に対するコメントのリストを返します
add_issue_comment問題にコメントを追加する

ウィキツール

ツール名説明
get_wiki_pagesWikiページのリストを返します
get_wikis_countプロジェクト内のWikiページの数を返します
get_wiki特定のWikiページに関する情報を返します
add_wiki新しい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ユーザーのウォッチアイテムの数を返します

使用例

AIエージェントでMCPサーバーを設定すると、会話の中でツールを直接使用できるようになります。以下に例をいくつか示します。

プロジェクトの一覧

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

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 フラグを付けてバイナリを実行すると、現在のデフォルトの翻訳 (オーバーライドを含む) をエクスポートできます。

これにより、行ったカスタマイズも含め、すべてのツールの説明が stdout に出力されます。

例:

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. 変更をビルドしてテストする

ライセンス

このプロジェクトは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.

Claude が API 統合を通じて Backlog プロジェクト管理ツールと対話し、プロジェクト、問題、Wiki ページ、その他の 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