mcpField
R
runbook

runbook

github.com/anthropics云与 DevOps33.6k3.1k 次安装1 天前更新
代码仓库

关于 runbook

runbook 是用于为重复任务或操作流程编写分步操作手册的技能，面向运维等团队。它强调精确操作、预期结果、失败处理与完成验证。

主要功能

  1. 01生成分步操作手册
  2. 02记录负责人和执行频率
  3. 03为每步列出预期结果与故障处理
  4. 04提供验证清单和故障排查

适用场景

  1. 01记录周期性运维流程
  2. 02为团队交接操作步骤
  3. 03补充操作失败时的处理方式

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/anthropics/knowledge-work-plugins --skill runbook

安装后在 Claude Code 中输入/runbook确认已加载。

详细介绍

/runbook

如果你看到不熟悉的占位符，或需要确认哪些工具已连接，请参阅 CONNECTORS.md。

为周期性任务或流程创建分步骤的运维手册。

用法

/runbook $ARGUMENTS

输出

## Runbook: [Task Name]
**Owner:** [Team/Person] | **Frequency:** [Daily/Weekly/Monthly/As Needed]
**Last Updated:** [Date] | **Last Run:** [Date]

### Purpose
[What this runbook accomplishes and when to use it]

### Prerequisites
- [ ] [Access or permission needed]
- [ ] [Tool or system required]
- [ ] [Data or input needed]

### Procedure

#### Step 1: [Name]

[Exact command, action, or instruction]

**Expected result:** [What should happen]
**If it fails:** [What to do]

#### Step 2: [Name]

[Exact command, action, or instruction]

**Expected result:** [What should happen]
**If it fails:** [What to do]

### Verification
- [ ] [How to confirm the task completed successfully]
- [ ] [What to check]

### Troubleshooting
| Symptom | Likely Cause | Fix |
|---------|-------------|-----|
| [What you see] | [Why] | [What to do] |

### Rollback
[How to undo this if something goes wrong]

### Escalation
| Situation | Contact | Method |
|-----------|---------|--------|
| [When to escalate] | [Who] | [How to reach them] |

### History
| Date | Run By | Notes |
|------|--------|-------|
| [Date] | [Person] | [Any issues or observations] |

如果连接器可用

如果已连接 ~~knowledge base：

  • 搜索现有的运维手册进行更新，而不是从头创建
  • 将完成的运维手册发布到你的运维 Wiki

如果已连接 ~~ITSM：

  • 将运维手册关联到相关的事件类型和变更请求
  • 根据值班排期自动填充升级联系人

提示

  1. 务必极其具体：“运行脚本”不是一个有效的步骤。“在运维服务器上运行 python sync.py --prod --dry-run”才是。
  2. 列出故障模式：每个步骤中可能出现什么问题，以及应如何应对。
  3. 测试运维手册：让不熟悉该流程的人按照手册操作，并修正他们卡住的地方。

评论

支持 Markdown