mcpField
B
bmad-module-builder

bmad-module-builder

github.com/bmad-code-orgAgent workflows217110 installsUpdated 5w ago
Repository

About bmad-module-builder

bmad-module-builder helps BMad users plan, scaffold, and validate installable modules from ideas or existing skills. It offers separate ideation, creation, and validation paths, with headless support for creation and validation.

Key features

  1. 01Brainstorm module ideas and architecture
  2. 02Create installable module scaffolding
  3. 03Generate setup skills for multi-skill modules
  4. 04Embed registration in single-skill modules
  5. 05Validate module structure and capabilities
  6. 06Headless creation and validation

Use cases

  1. 01Plan a module from an initial idea
  2. 02Package existing skills as a module
  3. 03Prepare setup for a multi-skill module
  4. 04Check module structure and registrations

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bmad-code-org/bmad-builder --skill bmad-module-builder

After installing, type/bmad-module-builderin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

assets/
module-plan-template.md
assets/setup-skill-template/assets/
module-help.csv
module.yaml
assets/setup-skill-template/scripts/
cleanup-legacy.py
merge-config.py
merge-help-csv.py
assets/standalone-module-template/
merge-config.py
merge-help-csv.py
module-setup.md
references/
create-module.md
ideate-module.md
validate-module.md
scripts/
scaffold-setup-skill.py
scaffold-standalone-module.py
validate-module.py
scripts/tests/
test-scaffold-setup-skill.py
test-scaffold-standalone-module.py
test-validate-module.py

Details

From the project README

BMad Module Builder

Overview

This skill helps you bring BMad modules to life — from the first spark of an idea to a fully scaffolded, installable module. It offers three paths:

  • Ideate Module (IM) — A creative brainstorming session that helps you imagine what your module could be, decide on the right architecture (agent vs. workflow vs. both), and produce a detailed plan document. The plan then guides you through building each piece with the Agent Builder and Workflow Builder.
  • Create Module (CM) — Takes an existing folder of built skills (or a single skill) and scaffolds the module infrastructure that makes it installable. For multi-skill modules, generates a dedicated -setup skill. For single skills, embeds self-registration directly into the skill. Supports --headless / -H.
  • Validate Module (VM) — Checks that a module's structure is complete and correct — every skill has its capabilities registered, entries are accurate and well-crafted, and structural integrity is sound. Handles both multi-skill and standalone modules. Supports --headless / -H.

Args: Accepts --headless / -H for CM and VM paths, an initial description for IM, or a path to a skills folder or single SKILL.md file for CM/VM.

On Activation

Load available config from {project-root}/_bmad/config.yaml and {project-root}/_bmad/config.user.yaml (root level and bmb section). If neither exists, fall back to {project-root}/_bmad/bmb/config.yaml (legacy per-module format). If still missing, let the user know bmad-builder-setup can configure the module at any time. Use sensible defaults for anything not configured.

Detect user's intent:

  • Ideate / Plan keywords or no path argument → Load ./references/ideate-module.md
  • Create / Scaffold keywords, a folder path, or a path to a single SKILL.md file → Load ./references/create-module.md
  • Validate / Check keywords → Load ./references/validate-module.md
  • Unclear → Present options:
    • Ideate Module (IM) — "I have an idea for a module and want to brainstorm and plan it"
    • Create Module (CM) — "I've already built my skills and want to package them as a module"
    • Validate Module (VM) — "I want to check that my module's setup skill is complete and correct"

If --headless or -H is passed, route to CM with headless mode.

Comments

Markdown supported