bmad-generate-project-context

Generate a project-context.md document with YAML frontmatter and structured sections.

Updated Apr 25, 2026

Search Tags:#documentation #workflow-automation #frontmatter #software-engineering #project-context #ai-guidelines #llm-optimization

Ready to run

npx skills add https://github.com/ldk-hub/broke-shopping --skill bmad-generate-project-context-ldk-hub

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-generate-project-context
Source: https://github.com/ldk-hub/broke-shopping/tree/main/_bmad/bmm/3-solutioning/bmad-generate-project-context
Command: npx skills add https://github.com/ldk-hub/broke-shopping --skill bmad-generate-project-context-ldk-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create a lean, AI-ready project context document that encodes project conventions and operational guidelines for AI agents.

Core Features & Use Cases

Workflow-driven context generation: coordinates a multi-step process to discover, generate, and finalize a project context.
Frontmatter-driven metadata: ensures a structured YAML frontmatter defines essential fields like name and description.
Artifact management and extensibility: supports optional components (scripts, references, assets) as needed by the skill.

Quick Start

Begin by executing the end-to-end workflow to create or update {output_folder}/project-context.md by following step-01-discover, step-02-generate, and step-03-complete.

Frequently Asked Questions about bmad-generate-project-context

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate an AI-ready project context document for my codebase?▼

To generate an AI-ready project context document, execute a multi-step workflow that discovers project conventions, generates structured sections with YAML frontmatter, and finalizes the project-context.md file for AI agent consumption.

What is a project context file and when do I need one for AI agents?▼

A project context file is a lean, AI-ready markdown document that codifies technology stacks, patterns, and workflow rules. You need one when AI agents must follow standardized conventions in new codebases or ongoing software engineering projects.

How do I ensure correct frontmatter metadata in my AI project context?▼

Correct frontmatter metadata is ensured by generating a structured YAML header that defines essential fields like name and description, validating correctness as part of the automated project context generation workflow.

Can I include optional resource directories and assets in my project context rules?▼

Yes, you can include optional resource directories, scripts, references, and assets as needed. The generated project context supports artifact management and extensibility for optional components required by your workflow.

Does this project context generation approach work for existing ongoing projects?▼

Yes, this project context generation works for both new codebases and ongoing projects. It discovers existing conventions and encodes standardized technology stacks, patterns, and workflow rules into a lean AI-ready document.

What is the best way to structure project conventions for LLM optimization?▼

The best way to structure project conventions for LLM optimization is to use a lean, AI-ready markdown format with structured sections, YAML frontmatter, and a clear status workflow, ensuring AI agents can reliably parse and follow operational guidelines.