Backlog MCP Qsd

🚀 Backlog MCP Server

An MCP (Message Communication Proxy) server that provides support for the Backlog interface.

🚀 Quick Start

The Backlog MCP Server is designed to offer comprehensive support for Backlog interfaces, enabling seamless operations such as project management, task handling, and more.

✨ Features

Supported Functions

• Project Management: Retrieve project-related information.
• Task Management: Perform operations on tasks (create, update, delete, etc.).
• Search Function: Filter tasks based on specified conditions.
• Status Management: Handle operations related to project status.
• User Information: Obtain user profiles.

Supported Backlog Versions

• Standard Plan
• Professional Plan

📚 Documentation

Project-related Tools

getSpaces

• Function: Retrieve a list of available spaces (projects).
• Input: None
• Output: Return a data structure containing space information.

getProjects

• Function: Get all projects within a specific space.
• Input: Specify the space ID or name.
• Output: Return a list of projects under the corresponding space.

Task-related Tools

createIssue

• Function: Create a new task.
• Input: Parameters such as task title, content, and priority.
• Output: Return detailed information about the newly created task.

updateIssue

• Function: Update the information of an existing task.
• Input: Task ID and fields to be modified.
• Output: Return the updated task details.

deleteIssue

• Function: Delete a specified task.
• Input: Task ID
• Output: Confirm the successful deletion status.

Search-related Tools

searchIssues

• Function: Search for tasks based on specified conditions.
• Input: Filtering conditions such as keywords, project ID, status ID, and assignee ID.
• Output: Return a list of tasks that meet the filtering conditions.

🔧 Technical Details

Environment Variable Configuration

Add the following content to the .env file:

BACKLOG_DOMAIN=your-domain.backlog.com
BACKLOG_API_KEY=your-api-key

# Test environment configuration (optional)
TEST_PROJECT_ID=your-test-project-id
TEST_PROJECT_KEY=your-test-project-key

Usage in Claude Desktop

Add the following configuration to the claude_desktop_config.json file:

When Using NPX

{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": ["-y", "@tmhr1850/backlog-mcp-server"],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

Local Execution Commands

# Perform the build
npm run build

# Start the service
npm start

Testing Commands

# Run all tests
npm test

# Start the test in watch mode
npm run test:watch

# Run tests with a coverage report
npm run test:coverage

📄 License

This MCP server is released under the MIT License. For detailed license information, please refer to the LICENSE file in the project repository.