使用说明
项目简介
'Backlog.md MCP Server' 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在将流行的 Backlog.md 任务管理系统功能,以标准化方式提供给大型语言模型(LLM)客户端(例如 Claude)。它通过封装 Backlog.md 命令行工具,使 AI 助手能够直接创建、列出、编辑任务,管理草稿,查看看板,并访问项目配置、文档和决策记录,极大地提升了 LLM 在项目管理和任务协作方面的能力。
主要功能点
- 任务管理: 全面支持创建、列出、编辑、查看、归档和降级任务。包括对详细任务属性、验收标准、标签、依赖关系、父子任务的完整支持。
- 草稿管理: 允许创建、列出、推广、归档和查看草稿任务,提供灵活的任务规划。
- 文档与决策: 能够创建、列出、查看文档文件和决策记录,方便知识管理和项目决策追踪。
- 看板与项目概览: 可显示实时看板视图,并将看板导出为 Markdown 文件;提供详细的项目统计和概览信息。
- 配置管理: 允许获取和设置 Backlog.md 的配置值,适应不同项目需求。
- 依赖序列: 基于任务依赖性自动计算并列出执行序列,帮助用户理解任务间的先后顺序和并行性。
- 资源访问: 通过标准化的 'backlog://' URI,LLM 客户端可以直接访问所有任务列表、看板、草稿、文档、决策记录和项目统计信息,实现丰富的上下文服务。
安装步骤
在开始使用之前,请确保您的系统满足以下先决条件:
- 安装 Node.js: 确保您的系统已安装 Node.js 18 或更高版本。您可以从 Node.js 官网 下载安装。
- 安装 Backlog.md CLI: MCP 服务器依赖于 Backlog.md 命令行工具。请先全局安装它:
npm install -g backlog.md - 初始化项目: 在您的项目目录中运行 Backlog.md 初始化命令,创建必要的项目结构:
backlog init - 安装 Backlog.md MCP 服务器: 全局安装 MCP 服务器包:
npm install -g @radleta/backlog-md-mcp
服务器配置 (供 MCP 客户端使用)
当您将此 MCP 服务器添加到支持 MCP 协议的 LLM 客户端(如 Claude Code)时,通常需要配置其启动命令。以下是用于 MCP 客户端的 JSON 配置示例:
{ "serverName": "backlog-md", "command": "backlog-mcp", "args": ["start"] }
配置说明:
- '"serverName"': 用于在 MCP 客户端中标识此服务器的名称。
- '"command"': 启动 MCP 服务器的可执行文件路径或命令名称(如果已添加到系统 PATH)。
- '"args"': 传递给启动命令的参数列表。'"start"' 参数用于启动 MCP 服务器。
您可以在 'args' 中添加其他选项,例如:
- '"args": ["start", "--verbose"]' 启用详细日志输出,便于调试。
基本使用方法
安装并配置完成后,您可以在 LLM 客户端中通过自然语言与 Backlog.md 进行交互:
- 创建任务: "创建一个高优先级的任务,标题为 '实现用户认证功能',并添加验收标准:'单元测试通过','代码审查通过'。"
- 列出任务: "列出所有状态为 '进行中' 的任务。"
- 编辑任务: "编辑任务 task-123,将其状态改为 '已完成',并添加标签 '后端'。"
- 查看看板: "显示当前的看板。"
- 获取配置: "获取项目的当前配置。"
- 创建草稿: "创建一个标题为 '研究新的数据库方案' 的草稿任务。"
- 查看文档: "查看所有项目文档。"
信息
分类
生产力应用