MCP Backlog Server

🚀 mcp-backlog-server

這是一個將Backlog與Model Context Protocol (MCP) 相結合的TypeScript基礎服務器，實現了MCP的主要概念，可通過資源管理、工具集和提示功能，有效整合Backlog的功能，並通過MCP協議實現與外部系統的交互。

🚀 快速開始

使用本項目前，需滿足以下系統要求：

• 配備API訪問權限的Backlog賬戶
• 環境變量：
  • BACKLOG_API_KEY：Backlog API密鑰
  • BACKLOG_SPACE_URL：Backlog空間URL（如：https://your-space.backlog.com）

安裝依賴

npm install

構建服務器

npm run build

監視模式開發

npm run watch

✨ 主要特性

資源管理

• 通過backlog://project/[id] URI訪問Backlog項目。
• 每個項目資源包含項目元數據和詳細信息。
• 提供結構化數據訪問，支持JSON格式輸出。
• 支持訪問項目中的問題（Issue）和Wiki頁面。

工具集

• get_backlog_user：獲取當前Backlog用戶信息。
• get_backlog_space：獲取Backlog空間信息。
• list_recent_projects：列出最近訪問的Backlog項目，支持指定數量和排序順序。
• get_project_issues：獲取項目的Issue列表，支持按狀態、負責人和分頁過濾。
• get_issue_detail：獲取特定Issue的詳細信息。
• get_issue_comments：獲取Issue下的評論內容。
• add_issue_comment：向Issue添加新的評論。
• get_issue_comment_count：獲取Issue的總評論數。
• get_issue_comment：獲取指定評論的詳細信息。
• get_wiki_page_list：獲取Wiki頁面列表，支持按項目或關鍵詞過濾。
• get_wiki_page：獲取特定Wiki頁面的內容詳情。
• update_wiki_page：更新現有Wiki頁面內容。

提示功能

• summarize_projects：生成最近訪問項目的摘要信息。
• analyze_backlog_usage：基於用戶、空間和項目數據進行使用模式分析。
• summarize_wiki_pages：生成指定項目Wiki頁面的概要信息。

📦 安裝指南

安裝依賴

npm install

構建服務器

npm run build

監視模式開發

npm run watch

📚 詳細文檔

部署配置

在Claude Desktop中使用時，需添加服務器設置。具體路徑如下：

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

配置示例如下：

{
  "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"
      }
    }
  }
}

🔧 技術細節

項目結構主要由以下幾個關鍵文件組成：

• index.ts：入口文件，負責服務器初始化和配置。
• backlog-client.ts：處理與Backlog API的通信邏輯。
• 各處理器文件（tool-handlers.ts, prompt-handlers.ts, types.ts等）：分別處理工具交互、提示生成及類型定義。
• config.ts：負責從環境變量讀取配置信息。

通過以上設計，該服務器能夠有效整合Backlog的功能，並通過MCP協議實現與外部系統的交互。