MCP Backlog Server

🚀 mcp-backlog-server

This is a TypeScript-based server that combines Backlog with the Model Context Protocol (MCP). It implements the main concepts of MCP, including resources representing Backlog projects, tools for interacting with the Backlog API, and functions for generating data summaries and analysis prompts.

🚀 Quick Start

To start using the mcp-backlog-server, follow these steps:

Installation

npm install

Build the Server

npm run build

Development in Watch Mode

npm run watch

✨ Features

Resource Management

• Access Backlog projects via the backlog://project/[id] URI.
• Each project resource contains project metadata and detailed information.
• Provide structured data access with JSON format output support.
• Support access to issues and Wiki pages within projects.

Toolset

• get_backlog_user: Retrieve information about the current Backlog user.
• get_backlog_space: Get information about the Backlog space.
• list_recent_projects: List recently accessed Backlog projects, supporting the specification of quantity and sorting order.
• get_project_issues: Fetch the list of issues in a project, supporting filtering by status, assignee, and pagination.
• get_issue_detail: Obtain detailed information about a specific issue.
• get_issue_comments: Retrieve the comments under an issue.
• add_issue_comment: Add a new comment to an issue.
• get_issue_comment_count: Get the total number of comments on an issue.
• get_issue_comment: Fetch detailed information about a specified comment.
• get_wiki_page_list: Get the list of Wiki pages, supporting filtering by project or keyword.
• get_wiki_page: Retrieve the detailed content of a specific Wiki page.
• update_wiki_page: Update the content of an existing Wiki page.

Prompt Functions

• summarize_projects: Generate summary information for recently accessed projects.
• analyze_backlog_usage: Conduct usage pattern analysis based on user, space, and project data.
• summarize_wiki_pages: Generate summary information for Wiki pages in a specified project.

📦 System Requirements

• A Backlog account with API access privileges.
• Environment variables:
  • BACKLOG_API_KEY: Backlog API key.
  • BACKLOG_SPACE_URL: Backlog space URL (e.g., https://your-space.backlog.com).

🚀 Deployment Configuration

When using in Claude Desktop, you need to add server settings. The specific paths are as follows:

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

Here is a configuration example:

{
  "mcpServers": {
    "mcp-backlog-server": {
      "command": "/path/to/mcp-backlog-server/build/index.js",
      "env": {
        "BACKLOG_API_KEY": "your_api_key_here",
        "BACKLOG_SPACE_URL": "https://your-space.backlog.com"
      }
    }
  }
}

🔧 Technical Details

The project structure mainly consists of the following key files:

• index.ts: The entry file responsible for server initialization and configuration.
• backlog-client.ts: Handles the communication logic with the Backlog API.
• Various handler files (tool-handlers.ts, prompt-handlers.ts, types.ts, etc.): Handle tool interactions, prompt generation, and type definitions respectively.
• config.ts: Responsible for reading configuration information from environment variables.

Through the above design, this server can effectively integrate the functions of Backlog and interact with external systems through the MCP protocol.