What is Backlog Mcp Server

backlog-mcp-server is an MCP server implementation designed for integrating with the Backlog API, enabling seamless access to project management functionalities.

Use cases

Use cases include automating project updates, integrating issue tracking into CI/CD pipelines, and managing documentation through wikis in a collaborative workspace.

How to use

To use backlog-mcp-server, you need to obtain an API key from Backlog, set up environment variables for the API key and space ID, and configure it in your application using either NPX or Docker.

Key features

Key features include project management tools such as retrieving, adding, updating, and deleting projects and issues, as well as managing wikis through the Backlog API.

Where to use

backlog-mcp-server can be used in software development environments, project management applications, and any system that requires integration with Backlog for task and issue tracking.

[!CAUTION]
Official Backlog MCP server launched!

This repository will be changed visible.

https://nulab.com/ja/blog/backlog/released-backlog-mcp-server/

Backlog MCP Server

An MCP server implementation that integrates the Backlog API.

Tools

Project API

• backlog_get_projects
  • Execute projects get with pagination and filtering
• backlog_get_project
  • Execute project gets with project id or key

Issue API

• backlog_get_issues
  • Execute issues get with pagination and filtering
• backlog_get_issue
  • Execute issue gets with issue id or key
• backlog_add_issue
  • Execute issue add with issue data
• backlog_update_issue
  • Execute issue update with issue data
• backlog_delete_issue
  • Execute issue delete with issue id or key

Wiki API

• backlog_get_wikis
  • Execute wikis get with keyword
• backlog_get_wiki
  • Execute wiki gets with wiki id or key
• backlog_add_wiki
  • Execute wiki add with wiki data
• backlog_update_wiki
  • Execute wiki update with wiki data
• backlog_delete_wiki
  • Execute wiki delete with wiki id or key

Configuration

Getting an API Key

1. Sign up for a Backlog
2. Choose a plan (Free plan available here)
3. Generate your API key from the individual settings help

Environment Variables

This server requires the following environment variables:

• Required:
  • BACKLOG_API_KEY: Your Backlog API key
  • BACKLOG_SPACE_ID: Your Backlog space ID
• Optional:
  • BACKLOG_BASE_URL: Your Backlog base URL (default: https://{your-space-id}.backlog.com/api/v2)

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

NPX

{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": [
        "-y",
        "backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_API_KEY": "YOUR_API_KEY_HERE",
        "BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE"
      }
    }
  }
}

Docker

{
  "mcpServers": {
    "backlog": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "BACKLOG_API_KEY=YOUR_API_KEY_HERE",
        "-e",
        "BACKLOG_SPACE_ID=YOUR_SPACE_ID_HERE",
        "mcp/backlog"
      ],
      "env": {
        "BACKLOG_API_KEY": "YOUR_API_KEY_HERE",
        "BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE"
      }
    }
  }
}

Development

Installation

npm install

Build

npm run build

Debug

npm run debug

Running Tests

T.B.D

Docker Build

docker build -t mcp/backlog -f Dockerfile .

Extending the Server

To add new tools:

1. Define a new Zod schema in src/core/schema.ts
2. Add a new tool definition in src/tools/toolDefinitions.ts and include it in ALL_TOOLS
3. Create a new handler in src/tools/handlers.ts and register it in toolHandlers
4. Implement business logic in a service in the src/services/ directory

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.