Backlog

You can deploy and run the Backlog MCP Server to let AI assistants interact with your Backlog space. This server exposes a set of read and write tools that enable you to retrieve information from Backlog and perform actions such as creating and updating issues, managing pull requests, browsing documents, and working with wikis and shared files. Use an MCP client to connect to this local or remote server and perform automation tasks against Backlog data.

How to use

You will connect an MCP client to the Backlog MCP Server to access read and write capabilities across Backlog modules like Issues, Git/Pull Requests, Documents, Wikis, Projects, and Shared Files. Start by configuring an MCP client to run the server as a local process or connect to a remote MCP endpoint if one is provided. Once connected, you can request data such as issue details, repository lists, or wiki pages, and you can perform actions like creating an issue, updating a wiki page, or adding a comment to a pull request. Use the client’s allowed tools filters to enable only the Backlog-related tools you want to expose to the assistant, and ensure any required API keys and base URLs are supplied via environment configuration.

How to install

Prerequisites: you need a Rust toolchain installed to build the MCP server, and you may use a package manager or build directly from source.

Install using Homebrew (recommended for macOS/Linux):

# Add the tap (only needed once)
brew tap safx/tap

# Install the tools
brew install mcp-backlog-server  # MCP server for AI assistants
brew install blg                 # Backlog CLI tool (Optional)

To update to the latest version, run these commands:

brew update
brew upgrade mcp-backlog-server
brew upgrade blg

To uninstall the packages:

brew uninstall mcp-backlog-server
brew uninstall blg
brew untap safx/tap  # Optional: remove the tap

Alternative installation methods are available for other platforms or if you prefer not to use Homebrew: you can download pre-built binaries or build from source with Rust/Cargo.

Additional configuration and runtime details

Configure the server with environment variables that the MCP client system will pass when launching the server. The commonly used environment variables are:

BACKLOG_BASE_URL
BACKLOG_API_KEY
BACKLOG_PROJECTS
BACKLOG_PREFIX

These variables enable the server to connect to your Backlog space, limit access to specific projects, and define a custom prefix for tool names. Use the following example configurations to run the server from a client environment.

Troubleshooting and notes

If you encounter connection issues, verify that BACKLOG_BASE_URL and BACKLOG_API_KEY are correct and that the Backlog space accepts requests from your environment. Ensure that BACKLOG_PROJECTS includes the projects you intend to access. If you need more detailed logs, run the server with verbose output if your client supports it, and check for any network restrictions that block API calls.

Available tools

document_details_get

Retrieve details for a specific Backlog document.

document_attachment_download

Download a document attachment.

document_tree_get

Get the document tree for a specified project.

git_repository_list_get

Get a list of Git repositories for a specified project.

git_repository_details_get

Get details for a specific Git repository.

git_pr_list_get

Get a list of pull requests for a specified repository.

git_pr_details_get

Get details for a specific pull request.

git_pr_attachment_list_get

Get a list of attachments for a specific pull request.

git_pr_comment_list_get

Get a list of comments for a specific pull request.

git_pr_attachment_download

Download a pull request attachment.

git_pr_comment_add

Add a comment to a specific pull request.

issue_details_get

Retrieve details for a specific Backlog issue.

issue_milestone_list_get

Retrieve a list of versions (milestones) for a specified project.

issue_list_by_milestone_get

Retrieve a list of issues associated with a specified milestone.

issue_update

Update a Backlog issue including summary, description, and custom fields.

issue_comment_list_get

Get comments for a specific issue.

issue_attachment_list_get

Get a list of attachments for a specified issue.

issue_attachment_download

Download an issue attachment.

issue_shared_file_list_get

Get a list of shared files linked to a specified issue.

issue_comment_update

Update an existing comment on a Backlog issue.

issue_add

Create a new issue in a Backlog project with support for custom fields.

issue_comment_add

Add a comment to a specific issue.

issue_priority_list_get

Get a list of priority types available in the space.

project_status_list_get

Get a list of statuses for a specified project.

project_issue_type_list_get

Get a list of issue types for a specified project.

project_custom_field_list_get

Get a list of custom fields defined for a specified project.

file_shared_list_get

Get a list of shared files for a specified project directory.

file_shared_download

Download a shared file.

user_list_get

Get a list of users in the space.

wiki_list_get

Get a list of wiki pages.

wiki_details_get

Get detailed information about a specific wiki page.

wiki_attachment_list_get

Get a list of attachments for a specified wiki page.

wiki_attachment_download

Download an attachment from a wiki page.

wiki_update

Update a wiki page.