Backlog MCP Server

🚀 Backlog MCP Server

Backlog MCP Server is a tool that provides a series of configurations and operations for Backlog services, supporting Docker installation, custom configuration, and internationalization.

🚀 Quick Start

Installation

Install with Docker

Run the following command to install using Docker:

docker run -i --rm ghcr.io/nulab/backlog-mcp-server

Or run the image directly:

npx github:nulab/backlog-mcp-server

Configuration

Default Configuration File

The default configuration file is ~/.backlog-mcp-serverrc.json.

Custom Configuration File

Create or modify the mcp-config.json file in your working directory with the following content:

{
  "mcpServers": {
    "backlog": {
      "command": "node",
      "args": [
        "build/index.js"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

Configuration for Docker Installation

When running Docker, you can mount the configuration file in the following way:

docker run -i --rm \
  -v /yourcurrentdir/mcp-config.json:/root/.backlog-mcp-serverrc.json:ro \
  ghcr.io/nulab/backlog-mcp-server

Usage

Start the Server

Run the following command to start the server:

node build/index.js

Or use Docker:

docker run -i --rm ghcr.io/nulab/backlog-mcp-server

📚 Documentation

Configuration File Structure

The configuration file contains the following structure:

• mcpServers: Defines the MCP server.
  • backlog: Contains the following attributes:
    • command: The execution command (e.g., node, docker).
    • args: An array of command arguments.
    • env: Environment variables, including required items:
      • BACKLOG_DOMAIN: The Backlog domain name.
      • BACKLOG_API_KEY: The Backlog API key.

Configuration Example

The following is a complete configuration example:

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

Environment Variables

Environment variables take precedence over the configuration file and can be set in the following way:

docker run -i --rm \
  -e BACKLOG_DOMAIN=your-domain.backlog.com \
  -e BACKLOG_API_KEY=your-api-key \
  ghcr.io/nulab/backlog-mcp-server

Description Override

You can override the tool descriptions by creating a .backlog-mcp-serverrc.json file:

{
  "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "Chinese description of the comment tool",
  "TOOL_CREATE_PROJECT_DESCRIPTION": "Chinese description of the project creation tool"
}

Export Current Translations

Run the following command to export the current translations:

node build/index.js --exportTranslations

Internationalization Settings

It supports internationalization files in .json, .yaml, and .yml formats.

Example YAML File

translation:
  key1: "value1"
  key2: "value2"

Development and Testing

Add a New Tool

Create a new command file in the commands directory, for example:

const Command = require('@backlog/mcp-server').Command;

class MyCommand extends Command {
  // Define your command logic
}

module.exports = MyCommand;

Testing

Use Mocha for testing. After installing the dependencies, run:

npm test

Help Information

Run the following command to get help information:

node build/index.js --help