关键词

Backlog项目管理任务管理问题跟踪工作流自动化

使用说明

项目简介

Backlog MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，它充当 LLM 客户端和 Backlog 项目管理工具之间的桥梁。该服务器的主要目的是使 LLM 能够以标准化的方式访问和操作 Backlog 中的项目、问题、Wiki、用户活动等资源，从而扩展 LLM 在项目管理和团队协作领域的应用能力。

主要功能点

  • Backlog 空间信息检索: 获取 Backlog 空间的基本信息。
  • 项目管理:
    • 列出和搜索项目，包括已归档项目。
    • 获取项目详情。
  • 问题管理:
    • 搜索、查看和管理问题。
    • 获取最近查看的问题列表。
  • Wiki 页面访问:
    • 访问 Wiki 页面内容。
    • 获取最近查看的 Wiki 列表。
  • 用户活动追踪:
    • 查看用户活动和通知。
    • 获取用户信息，包括当前用户信息和指定用户信息。
    • 列出 Backlog 空间中的所有用户。
  • 每日活动报告: 根据用户和日期生成每日活动报告，汇总用户在 Backlog 上的工作记录。

安装步骤

  1. 克隆仓库 
    git clone https://github.com/digitalcube/advanced-backlog-mcp-server.git
cd advanced-backlog-mcp-server
  2. 安装依赖 确保已安装 Node.js (v14 或更高版本) 和 npm。运行命令安装项目依赖： 
    npm install
  3. 构建服务器 运行命令构建服务器代码： 
    npm run build

服务器配置

要将 Backlog MCP 服务器与 MCP 客户端（例如 Claude Desktop）连接，您需要配置客户端以指向此服务器。以下是 Claude Desktop 的配置示例，其他 MCP 客户端的配置方法类似。

编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'：

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

在 'mcpServers' 字段下添加一个新的服务器配置项，例如 'advanced-backlog-mcp-server'：

{
  "mcpServers": {
    "advanced-backlog-mcp-server": {
      "command": "/path/to/advanced-backlog-mcp-server/build/index.js",
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

配置参数说明:

  • server name ('advanced-backlog-mcp-server'): 服务器名称，可以自定义，用于在 MCP 客户端中标识和引用该服务器。
  • command: MCP 服务器的启动命令。
    • '/path/to/advanced-backlog-mcp-server/build/index.js' 需要替换为 服务器 'index.js' 文件的绝对路径。
    • 您可以在仓库根目录下执行 'echo ""$(pwd)/build/index.js""' (macOS/Linux) 或 'echo "%cd%/build/index.js"' (Windows) 获取到正确的路径，并将其复制到配置文件中。
  • env: 环境变量配置，用于服务器运行时访问 Backlog API。
    • BACKLOG_DOMAIN: 您的 Backlog 域名，例如 'your-domain.backlog.com'。请替换为您的实际域名。
    • BACKLOG_API_KEY: 您的 Backlog API 密钥。您需要在您的 Backlog 账户设置中创建 API 密钥，并将其替换为实际的密钥。

获取 Backlog API 密钥:

  1. 登录您的 Backlog 账户。
  2. 进入 "个人设置" 或 "账户设置" 页面。
  3. 找到 "API 密钥" 或 "开发者设置" 选项。
  4. 创建一个新的 API 密钥并复制它。

基本使用方法

配置完成后，MCP 客户端（如 Claude Desktop）即可连接到 Backlog MCP 服务器。您可以使用自然语言查询与 Backlog 进行交互。

在 MCP 客户端中，您可以尝试以下自然语言查询示例:

  • "显示我最近的所有问题"
  • "列出我的 Backlog 空间中的所有项目"
  • "查找分配给我且优先级高的问题"
  • "生成今天的 Backlog 活动报告" (可能需要客户端支持调用 'list_backlog_daily_activities' 工具，并提供用户ID和日期参数)

可用工具 (Tools):

服务器注册了以下工具，供 MCP 客户端调用以执行特定操作：

  • 'list_backlog_space': 获取 Backlog 空间信息。
  • 'list_backlog_projects': 列出项目。
  • 'list_backlog_recently_viewed_issues': 列出最近查看的问题。
  • 'search_backlog_issues': 搜索问题（支持丰富的搜索条件）。
  • 'get_backlog_issue': 获取问题详情。
  • 'list_backlog_recently_viewed_projects': 列出最近查看的项目。
  • 'get_backlog_project': 获取项目详情。
  • 'list_backlog_recently_viewed_wikis': 列出最近查看的 Wiki。
  • 'get_backlog_wiki': 获取 Wiki 详情。
  • 'list_backlog_recent_user_activities': 列出用户活动。
  • 'get_backlog_current_user': 获取当前用户信息。
  • 'get_backlog_user': 获取指定用户信息。
  • 'list_backlog_users': 列出所有用户。
  • 'list_backlog_own_notifications': 列出用户通知。
  • 'list_backlog_daily_activities': 获取用户的每日活动报告。

请参考 MCP 客户端的文档，了解如何使用这些工具以及如何构建自然语言查询来调用它们。

信息

分类

生产力应用

访问项目