mcpField
R
runbook-generator

runbook-generator

github.com/onewave-aiCloud & DevOps398238 installsUpdated 1w ago
Repository

About runbook-generator

runbook-generator is a skill for creating operational runbooks from a codebase, infrastructure configuration, and deployment scripts. It guides discovery and verification so on-call engineers get actionable procedures and a record of operational gaps.

Key features

  1. 01Codebase and infrastructure discovery
  2. 02Nine-section runbook structure
  3. 03Commands derived from project files
  4. 04Verification markers for unknowns

Use cases

  1. 01Preparing incident response procedures
  2. 02Documenting deployment and rollback steps
  3. 03Finding missing operational documentation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/onewave-ai/claude-skills --skill runbook-generator

After installing, type/runbook-generatorin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
discovery-patterns.md
output-template.md
writing-style.md

Details

From the project README

Runbook Generator

Generate a comprehensive operational runbook.md from a system's codebase, infrastructure config, and deployment scripts -- written for on-call engineers working incidents, deployments, and routine operations at 3am.

Contents

  • references/discovery-patterns.md -- Glob/Grep patterns and config files to inspect during discovery.
  • references/output-template.md -- The full 9-section runbook.md structure to populate.
  • references/writing-style.md -- Clarity, urgency, completeness, formatting, and accuracy rules plus output requirements.

Workflow

  1. Discover the system. Run the Glob patterns in references/discovery-patterns.md (Step 1) to identify the stack and infrastructure.
  2. Read key configuration. Open and analyze the config files listed in references/discovery-patterns.md (Step 2): IaC, containers, CI/CD, app config, deploy scripts, monitoring, migrations, load balancers, docs.
  3. Identify operational behavior. Run the Grep patterns in references/discovery-patterns.md (Step 3) to surface health checks, metrics, caching, jobs, migrations, rollback, scaling, backups, TLS, secrets, alerting, and more.
  4. Generate the runbook. Produce runbook.md following the structure in references/output-template.md. Cover all 9 sections; adapt content to what discovery found; never include purely speculative sections.
  5. Apply writing standards. Follow every rule in references/writing-style.md -- copy-pasteable commands, expected outputs, sequential steps, P1-first ordering, tables for structured data, and the accuracy rules.
  6. Verify and flag gaps. Confirm referenced paths and scripts exist. Mark unverifiable details with [VERIFY] and missing sections with [ACTION REQUIRED]: ... so the runbook doubles as a gap analysis.

Output

Write runbook.md to the project root (or a directory the user specifies). It must be 500+ lines, cover all 9 sections, contain real commands derived from the codebase, include at least one architecture diagram, carry a complete table of contents, and never fabricate infrastructure details. See references/writing-style.md for the full output checklist.

Comments

Markdown supported