使用说明

项目简介

Backlog是一款基于Git和Markdown的零配置任务管理工具,旨在促进开发者与AI智能体之间的顺畅协作。它将所有任务数据存储在Git仓库中的Markdown文件中,并通过Model Context Protocol (MCP) 服务器向AI智能体提供任务管理能力,支持托管资源、执行工具和渲染Prompt模板。

主要功能点

  • 任务管理: 创建、编辑、列表和查看任务,支持丰富元数据,如标题、描述、状态、优先级、指派人、标签等。
  • 分层结构: 支持父子孙任务关系,便于将大型项目或史诗级任务分解为更小的可管理单元。
  • AI友好: 集成Model Context Protocol (MCP) 服务器,使AI智能体能够直接通过协议调用任务管理功能,实现自动化任务创建、更新、查询和分析。
  • Git集成: 任务以纯Markdown文件形式存储在'.backlog/'目录中,所有更改都可作为Git提交历史的一部分,便于版本控制和协作。
  • 离线优先与便携: 所有项目状态均包含在Git仓库中,允许完全离线工作,并且可以轻松在不同环境间迁移。
  • 搜索与筛选: 提供强大的搜索和筛选功能,可根据内容、任务状态、指派人、标签、父任务ID、依赖关系等查找任务。
  • Prompt模板: 提供预设的Prompt模板(如创建Bug报告、生成周报、项目概览等),AI智能体可直接调用以执行特定任务流。

安装步骤

从源码构建

git clone https://github.com/veggiemonk/backlog
cd backlog
go build .

直接安装

go install github.com/veggiemonk/backlog@latest

安装完成后,无需额外初始化,即可在任何Git仓库目录下开始使用。

服务器配置 (供MCP客户端使用)

Backlog MCP服务器可以作为后端服务,为AI客户端(如Gemini、Claude或自定义AI代理)提供任务管理能力。AI客户端需要以下配置信息来连接和使用Backlog MCP服务器:

1. 标准I/O (Stdio) 传输协议配置

适用于在本地开发或容器化环境中,客户端与服务器通过标准输入/输出流通信。

{
  "name": "Backlog Task Manager",
  "command": "backlog",
  "args": ["mcp"],
  "description": "通过标准I/O与Backlog MCP服务器通信,提供任务创建、查询和管理功能。"
}

参数注释:

  • 'name': 服务器的显示名称。
  • 'command': 启动Backlog MCP服务器的命令行程序。
  • 'args': 传递给命令的参数,'mcp' 启动MCP服务器模式。
  • 'description': 服务器功能的简要描述。

2. HTTP 传输协议配置 (例如在端口 8106)

适用于通过HTTP请求进行通信的场景,客户端可以向指定的URL发送JSON-RPC请求。

{
  "name": "Backlog Task Manager (HTTP)",
  "command": "backlog",
  "args": ["mcp", "--http", "--port", "8106"],
  "description": "通过HTTP协议与Backlog MCP服务器通信,端口为8106,提供任务创建、查询和管理功能。",
  "url": "http://localhost:8106"
}

参数注释:

  • 'name': 服务器的显示名称。
  • 'command': 启动Backlog MCP服务器的命令行程序。
  • 'args': 传递给命令的参数,'mcp' 启动MCP服务器模式,'--http' 启用HTTP传输,'--port 8106' 指定监听端口。
  • 'description': 服务器功能的简要描述。
  • 'url': MCP服务器的HTTP端点URL。

AI客户端将利用这些配置来发现服务器提供的工具(如 'task_create', 'task_list', 'task_edit' 等)和Prompt模板(如 'weekly_summary', 'create_bug_report' 等),从而能够以结构化的方式与任务管理系统进行交互。

基本使用方法 (CLI)

  • 创建任务: 创建一个新任务,并指定描述、指派人、标签和优先级。

    backlog create "修复登录按钮样式" \
      -d "确保按钮在移动设备上居中显示,并支持深色模式。" \
      -a "小明" \
      -l "前端,bug" \
      --priority "高" \
      --ac "按钮在手机端居中" \
      --ac "按钮支持深色模式"
  • 列出任务: 筛选并排序任务列表。

    backlog list --status "待办,进行中" --assigned "小明" --sort "优先级,更新时间" --reverse
  • 查看任务详情: 查看特定任务的完整信息。

    backlog view T01.01 # 查看 ID 为 T01.01 的任务详情
  • 编辑任务: 修改现有任务的各项属性,例如标题、状态、验收标准等。

    backlog edit T02 \
      -t "优化数据库查询性能" \
      --status "完成" \
      --check-ac 1 # 编辑任务T02,更新标题、状态并勾选第一个验收标准
  • 搜索任务: 根据关键词在任务标题、描述、计划、备注、验收标准、标签和指派人中进行搜索。

    backlog search "用户认证" --status "待办" --assigned "小明"
  • 启动MCP服务器: 启动后台服务,以便AI客户端可以连接。

    # 使用标准I/O (默认,适用于本地或容器内通信)
    backlog mcp
    
    # 使用HTTP协议 (通过网络访问,例如在端口8106)
    backlog mcp --http --port 8106

信息

分类

开发者工具