Skip to content

Runbook Brief

Scaffolds an agent brief for producing an operational runbook. The rendered brief instructs an agent to analyze a service's architecture, document dependencies and failure modes, create step-by-step operational procedures, define escalation paths, and produce a runbook suitable for on-call engineers.

Namebrief-runbook
Version0.1.0
Categoryoperations
LicenseApache-2.0
Personaoperations
Tagsbrief, runbook, operations, incident, on-call
Sourcetemplates/brief-runbook

Render it

Three front doors, one catalog. Pick whichever suits the caller.

# CLI
npx @nanohype/sdk render brief-runbook --out ./my-app

# SDK
import { LocalSource, renderTemplate } from "@nanohype/sdk";
const result = await renderTemplate(source, "brief-runbook", variables);

# MCP — from an agent
get_template({ name: "brief-runbook" })

Variables

Required

ProjectName string
Project or team that owns this service
ServiceName string
Name of the service this runbook covers

Optional

InfraProvider string — defaults to aws
Primary infrastructure provider (aws, fly, vercel, cloudflare)
IncidentSeverityLevels string — defaults to P1,P2,P3,P4
Comma-separated severity levels used by the organization

What it produces

1 files. Placeholder names such as __APP_NAME__ are what the renderer substitutes into.

brief.md

Composes with