关于 mb-garden
mb-garden 是用于维护已有 Memory Bank 的 Agent 技能,面向需要整理文档、修复结构问题并保持导航清晰的项目。它提供确定性的 lint 和 doctor 工具,并可选配置 GitHub Actions 检查。
主要功能
- 01检查文档 frontmatter 与链接
- 02校验任务记录及必需字段
- 03整理过长或重复文档
- 04归档过时文档并保留指引
- 05可选配置 GitHub Actions 检查
适用场景
- 01修复 Memory Bank 的结构错误
- 02定期清理过时文档并同步索引
- 03在 GitHub Actions 中添加文档检查
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mrvladd-d/ memobank --skill mb-garden安装后在 Claude Code 中输入/mb-garden确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
assets/mb-doctor.mjsmb-lint.mjsmemory-bank-lint.yml详细介绍
mb-garden — Memory Bank 维护(文档整理)
- **功能:**维护 Memory Bank 文档,修复规范问题,并保持导航结构清晰。
- 适用场景:
.memory-bank/已存在,且你希望减少内容偏差、过时文档或路由失效的问题。 - **输入:**现有的
.memory-bank/。 - **输出:**更整洁的 Memory Bank、已解决的规范问题,以及可选的 CI 支持,用于持续维护。
目标
让 .memory-bank/ 保持准确、易于导航且便于快速加载。
mb-garden 负责维护和清理指导。当前软件包也提供确定性的工具资源,但 mb-lint 和 mb-doctor 仍是独立的关卡,各自承担不同职责。
前置条件
.memory-bank/已存在。
流程
1) 安装确定性维护工具
如果仓库尚未包含这些工具:
- 使用
assets/mb-lint.mjs创建scripts/mb-lint.mjs。 - 使用
assets/mb-doctor.mjs创建scripts/mb-doctor.mjs。 - 将它们设为可执行(可选)。
- 添加软件包脚本(可选):
"mb:lint": "node scripts/mb-lint.mjs"和"mb:doctor": "node scripts/mb-doctor.mjs"。
当前软件包位置在 mb-garden/assets 下包含这两项工具资源;这是打包细节,并不意味着 mb-garden 在概念上负责 doctor 的就绪检查职责。
然后运行:
node scripts/mb-lint.mjs
node scripts/mb-doctor.mjs
修复所有 ERROR 问题:
- 缺少 YAML frontmatter(description + status)
- 链接失效
- 缺少文件夹
index.md - 缺少或无效的、由 schema 支持的任务记录,包括缺少或无效的强制字段
tier - 已过时的
.memory-bank/tasks/backlog.md,或被用作工作流状态的 Markdown 任务卡片 - 旧的
risk/risk.level任务字段;任务路由仅使用task.tier
mb-lint 是结构和机械规范检查关卡。mb-doctor 是基于 mb-lint 的工作流/自主就绪检查关卡。默认的 mb-doctor 适用于常规健康检查和新建骨架。只有在 JSON 任务队列存在后才运行严格模式:在 /prd-to-tasks 之后、/autonomous 内执行调度器之前,或在队列已准备就绪时运行 /autopilot 之前:
node scripts/mb-lint.mjs
node scripts/mb-doctor.mjs --strict
对于任务注册表为空的纯生成骨架,不要将严格模式视为必需项。
2) 重构以提升易用性
- 将超过约 700 行的文档拆分为原子文档和路由索引。
- 确保关键概念由经典的双文档组合(
architecture说明是什么/为什么 +guides说明如何做)或等效的规范驱动支持文档覆盖。 - 将复制粘贴的代码/配置替换为指向源文件的链接。
3) 归档过时或已被取代的文档
- 将过时文档移至
.memory-bank/archive/。 - 在原位置保留简短的墓碑说明,并附上指向归档位置的链接。
4) 可选:添加 CI 关卡
如果仓库使用 GitHub Actions:
- 根据
assets/memory-bank-lint.yml创建.github/workflows/memory-bank-lint.yml。
5) 生成简短报告
将摘要(已更改内容 + 遗留事项)写入:
.tasks/TASK-MB-GARDEN/TASK-MB-GARDEN-S-01-final-report-docs-01.md
6) 每周维护清单
每周(或每完成 5–10 项有意义的更改)运行此清单:
- **Frontmatter 审查:**每个
.memory-bank/**/*.md都有description+status。 - **过时文档:**检查超过 2 周未更新的文档——归档或刷新。
- **概念覆盖检查:**每个关键概念都由对应的
architecture/<X>.md+guides/<X>.md文档对覆盖,或由路由清晰的等效规范驱动支持文档覆盖。 - RTM 同步:
requirements.md中的 RTM 与实际功能/测试状态一致。 - **任务记录规范:**已完成的任务在
.task.json中标记为 done,每个任务都有tier,且不存在没有功能链接的孤立任务。 - 变更日志:
.memory-bank/changelog.md包含近期更改的条目。 - 索引链接:
index.md和路由索引中的所有链接都能正确解析。 - 归档墓碑说明:
archive/中的每份文档都在原位置保留墓碑说明。
完成定义
node scripts/mb-lint.mjs通过(0 个错误)。node scripts/mb-doctor.mjs在默认模式下通过就绪门槛;在调度器/自动驾驶执行前,队列处理后通过--strict检查。- 索引导航清晰连贯。
- 没有明显的重复内容或未归档的过时文档。
- 每周检查清单中的事项均已处理。
评论
支持 Markdown