Backlog

🚀 Backlog MCP Server

An MCP server implementation integrating the Backlog API, which provides seamless access to Backlog's project, issue, and wiki management features.

🚀 Quick Start

This Backlog MCP Server integrates with the Backlog API, allowing you to manage projects, issues, and wikis efficiently. Follow the steps below to get started.

✨ Features

Tools

Project API

• backlog_get_projects
  • Retrieve projects with pagination and filters.
• backlog_get_project
  • Retrieve a project using its ID or key.

Issue API

• backlog_get_issues
  • Retrieve issues with pagination and filters.
• backlog_get_issue
  • Retrieve an issue using its ID or key.
• backlog_add_issue
  • Add an issue using issue data.
• backlog_update_issue
  • Update an issue using issue data.
• backlog_delete_issue
  • Delete an issue using its ID or key.

Wiki API

• backlog_get_wikis
  • Retrieve wikis with keywords.
• backlog_get_wiki
  • Retrieve a wiki using its ID or key.
• backlog_add_wiki
  • Add a wiki using wiki data.
• backlog_update_wiki
  • Update a wiki using wiki data.
• backlog_delete_wiki
  • Delete a wiki using its ID or key.

📦 Installation

Obtain API Key

1. Register an account on Backlog.
2. Select a plan (the free plan is available here).
3. Generate your API key from your personal 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 the following content 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"
      }
    }
  }
}

💻 Usage Examples

Basic Usage

Install Dependencies

npm install

Build the Project

npm run build

Debug the Server

npm run debug

Build Docker Image

docker build -t mcp/backlog .

🔧 Technical Details

Extending the Server

To extend the server, follow these steps:

1. Define Zod Schemas: Define corresponding Zod schemas for each tool in the schema.ts file.
2. Implement Tool Logic: Create handler functions for corresponding commands in the commands folder, such as get_projects.command.ts or add_issue.command.ts.
3. Register Tools: Register your tools in the index.ts file to ensure they are available for use.

By following these steps, you can easily extend the server to support more features.