Tmhr1850 Backlog MCP Server

🚀 Backlog MCP Server

An MCP server that provides access to the Backlog API, enabling functions such as project management, task tracking, and file operations.

✨ Features

• Project Management: Retrieve project lists and view detailed project information.
• Task Management: Create new tasks, update existing tasks, search for tasks, and add comments.
• User Management: Obtain user information.
• File Operations: Manage attached files.
• Comment Function: Add comments to tasks.
• Search Function: Search for tasks or projects.

🛠️ Tools

Project-related

getSpaces

• Retrieve space information.
• Input: None
• Output: Space information

getProjects

• Retrieve the project list.
• Input: None
• Output: Project list

Task-related

Create a New Task

• Input:
  • title: Task title (required)
  • content: Task content (optional, default is empty)
  • priority: Priority (optional, default is "Medium")
  • assigneeId: Assignee ID (optional, if not specified, the task will be unassigned)
• Output: Detailed information of the new task

Update an Existing Task

• Input:
  • taskId (required): ID of the task to be updated
  • title: New title (optional)
  • content: New content (optional)
  • priority: New priority (optional)
• Output: Detailed information of the updated task

Search for Tasks

• Input:
  • keyword (required): Keyword for searching task titles or content
  • projectId (optional): ID of a specific project
  • statusId (optional): Status ID (e.g., "Incomplete", "Completed")
  • assigneeId (optional): Assignee ID
• Output: List of tasks that meet the criteria

Add a Comment

• Input:
  • taskId (required): ID of the task to which the comment will be added
  • content (required): Comment content
• Output: Detailed information of the new comment, including the generated comment ID and timestamp

⚙️ Setup

Steps to Obtain an API Key

1. Log in to the Backlog website.
2. Go to Personal Settings > API > Issue a new API key.
3. Copy the generated API key.

Environment Variable Configuration

Add the following configuration 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 content 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 Run

# Perform the build
npm run build

# Start the service
npm start

🧪 Testing

# Run all tests
npm test

# Run tests in watch mode (automatically detect code changes)
npm run test:watch

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

📄 License

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