Backlog MCP Server

by MCP-Mirror

303 downloads
Not rated
GitHub

About

The Backlog MCP Server is an MCP (Model Context Protocol) server that integrates the Backlog API. It provides tools to manage projects, issues, and wikis directly from an MCP client. Intended for users who want to interact with their Backlog space through AI assistants like…

Details

Author
MCP-Mirror
Downloads
303
Categories
Other

- Full CRUD for Backlog projects, issues, and wikis
- Pagination and filtering on list endpoints
- Uses environment variables for authentication
- Supports NPX and Docker deployment
- Extensible architecture for adding new tools
- Licensed under MIT License

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Backlog MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Configure it by setting the required environment variables BACKLOG_API_KEY and BACKLOG_SPACE_ID (optionally BACKLOG_BASE_URL). Use either NPX (npx -y backlog-mcp-server) or a Docker image (mcp/backlog) in your claude_desktop_config.json. The server exposes tools for CRUD operations on projects, issues, and wikis.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "backlog mcp server": {
            "fleagne_backlog-mcp-server": {
                "command": "docker",
                "args": [
                    "build",
                    "-t",
                    "mcp/backlog",
                    "-f",
                    "Dockerfile",
                    "."
                ]
            }
        }
    }
}

McpServers

{
    "fleagne_backlog-mcp-server": {
        "command": "docker",
        "args": [
            "build",
            "-t",
            "mcp/backlog",
            "-f",
            "Dockerfile",
            "."
        ]
    }
}

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.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.