Skip to main content
reopt Handbook
reopt Handbook
Agentic Documentation

Paradigm Shift

Why Documentation Must ChangeAI-readable Design PrinciplesAI-assisted Writing Process

Practice by Document Type

Project Rule DocumentsFrom Docs to Skills, Plugins, and MCPAgent Documentation SecurityAPI Docs and SpecsREADME and OnboardingArchitecture Decision RecordsRunbooks and OperationsUser Guides and TutorialsKnowledge Bases and Internal Wikis

Operations

Maintenance StrategyTeam Documentation Culture

Appendix

TemplatesVerification ReportUpdates
Handbook›에이전틱 시대의 문서화 혁신›Runbooks and Operations
한국어English

Runbooks and Operations

Design runbooks that separate diagnosis, recommendation, action, approval, and rollback.

Key takeaways

  • Runbooks must be structured enough for an agent to diagnose and recommend safely while keeping risky actions behind approval boundaries.
  • Three modes separate agent authority: Diagnose (read-only) and Recommend are default-on, while Act runs only when approved.
  • Every action needs a numeric, observable condition, an explicit mode, a command, a verification check, and a rollback/recovery path.
  • Map MCP Tools to modes and approval: read-only tools auto-run, while destructive tools like rollback_release or rotate_secret require human or change approval.
  • MCP annotations are hints, not enforcement; enforce permissions with scopes, server-side auth, approval policy, and audit logs.

Runbooks make operational response repeatable. In an agentic setting, they must be structured enough for an agent to diagnose and recommend safely, while keeping risky actions behind approval boundaries.

Three Modes

ModeAgent authorityExampleDefault
Diagnoseread-onlyinspect logs, metrics, statusyes
Recommendpropose actionsuggest rollback or scale-upyes
Actexecute limited actionpurge cache, toggle safe flagonly when approved

Runbook Flow

Action Format

### Action: restart API worker

- **Condition**: p95 latency > 3s for 5 minutes and error rate < 1%
- **Mode**: Act allowed
- **Command**: `kubectl rollout restart deployment/api-worker`
- **Verify**: p95 latency < 1s within 5 minutes
- **Rollback/recovery**: `kubectl rollout undo deployment/api-worker`
- **Escalate**: call L1 if not recovered within 10 minutes

MCP Tool Boundary

ToolModeAnnotation hintApproval
get_metricsDiagnosereadOnlyHint: trueauto
list_deploymentsDiagnosereadOnlyHint: trueauto
purge_cacheActidempotentHint: truepolicy-dependent
rollback_releaseActdestructiveHint: truehuman approval
rotate_secretActdestructiveHint: truechange approval

MCP annotations are hints, not enforcement. Enforce permissions with scopes, server-side auth, approval policy, and audit logs.

Template

---
title: "Runbook: {service} - {incident}"
severity: "sev2"
services: ["{service}"]
owner: "{team}"
last_tested: "YYYY-MM-DD"
allowed_modes: ["diagnose", "recommend"]
---

## Trigger
- Alert:
- Condition:

## Diagnosis
| Step | Signal | Command/tool | Healthy threshold |
|---|---|---|---|

## Actions
### Action 1
- Condition:
- Mode:
- Command:
- Verify:
- Rollback/recovery:
- Approval required:

## Escalation
| Condition | Owner | Channel | SLA |
|---|---|---|---|

Checklist

ItemCheck
trigger is numeric and observable[ ]
diagnosis is read-only[ ]
actions have modes[ ]
destructive actions require approval[ ]
each action has verification and recovery[ ]
escalation and SLA are explicit[ ]

Related docs

Ch14. Enterprise Patterns

Enterprise Eve Agent Development · Combine Eve features into support, research, code, back-office, analytics, and incident-response agent patterns.

Ch3. Project Layout and Discovery

Enterprise Eve Agent Development · How Eve turns agent directory slots into a source manifest, and why path-derived identity is an operations contract.

Renewal and Risk

B2B SaaS Sales and Customer Success · Detect renewal risk early and operate a structured recovery process.

Cmd. /doctor

Claude Code Command Master · Diagnose and optionally repair setup and configuration (skill).

MCP Enterprise Data

Vercel Enterprise AI Platform · Connect enterprise systems to AI agents through MCP tools, resources, and prompts.

Architecture Decision Records

Capture architectural decisions so agents understand why the codebase is shaped this way.

User Guides and Tutorials

Structure user-facing documentation so agents can answer product questions with grounded context.

On this page

Three ModesRunbook FlowAction FormatMCP Tool BoundaryTemplateChecklist