mcpField
E
eng-runbook

eng-runbook

github.com/nexu-ioCloud & DevOps104.6k231 installsUpdated today
Repository

About eng-runbook

eng-runbook is a skill for producing a single-page engineering runbook from a service brief and DESIGN.md. It specifies service details, alerts, procedures, on-call coverage, and incident response in an HTML output.

Key features

  1. 01Reads DESIGN.md and identifies the service
  2. 02Service summary and dependency list
  3. 03Alerts with severity and first response
  4. 04Procedures and on-call rotation
  5. 05Five-step incident checklist
  6. 06HTML output contract

Use cases

  1. 01Documenting a service for on-call engineers
  2. 02Recording alert meanings and initial responses
  3. 03Presenting deploy, rollback, and key rotation procedures

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/nexu-io/open-design --skill eng-runbook

After installing, type/eng-runbookin Claude Code to confirm it loaded.

Bundled filesexample.html

Details

From the project README

Engineering Runbook Skill

Produce a single-page engineering runbook.

Workflow

  1. Read DESIGN.md.
  2. Identify the service from the brief.
  3. Layout:
    • Header: service name, owner team, severity tier, version.
    • Service summary paragraph + dependency list.
    • Alerts table: alert name / severity / what it means / first response.
    • Dashboards & links list.
    • Common procedures block (3–4) with code blocks (deploy, rollback, rotate keys).
    • On-call rotation table (week / primary / secondary / backup).
    • Incident response checklist (5 numbered steps).
  4. One inline <style>, semantic HTML, monospace for code blocks.

Output contract

<artifact identifier="runbook-name" type="text/html" title="Service Runbook">
<!doctype html>...</artifact>

Comments

Markdown supported