内容
<p align="center">
<img title="Runbook.AI" alt="Runbook.AI" width="20%" src="./assets/images/runbook.ai.png">
</p>
# Runbook MCP 服务器
Runbook MCP 服务器使您能够从 Claude Desktop 运行自己的 Runbook。
- 运行运维 Runbook(例如,部署服务、升级 Kubernetes 集群)
- 运行手动测试计划(例如,创建新的 EC2 实例,SSH 进入实例,并在其中运行集成测试)。
请观看下面的演示视频以了解其工作原理!

# 使用方法
## 步骤 1:使用 Claude Desktop 启动 MCP 服务器。
创建 `config.yaml`
将以下配置放入 `claude_desktop_config.json`。
```json
{
"mcpServers": {
"runbook": {
"command": "uv",
"args": [
"--directory",
"<ABSOLUTE_PATH>/runbook-mcp-server",
"run",
"runbook_server.py"
]
}
}
}
```
## 步骤 2:创建 Runbook
您可以使用 markdown 文件或文本文件作为 Runbook。参见 [示例](./examples-runbooks/)。
我们支持环境变量替换。
定义 `env.yaml`。
```yaml
env:
key: value
```
- `{env[key]}` 被替换为 `value`。
- `{var.name}` 被替换为变量值。
当文件更新时,重建索引。
您还可以使用 `create_runbook` 工具创建新的 Runbook。以下是一个示例提示:
*示例 1*
```
创建新的 Runbook:
- 名称:list_pods
- 内容:列出所有命名空间中的 Pod,找到未就绪的 Pod,并将其发送到 Slack。
您不需要解释内容。只需将其传递给工具。
```
## 步骤 3:运行 Runbook
要运行 Runbook,请执行以下步骤:
1. 从 Claude Desktop 点击“从 MCP 附加”。
2. 从集成列表中选择 `get_runbook_as_prompt`。
3. 传递要执行的 Runbook 名称。还要用逗号分隔的列表指定变量(例如,`var1=key1,var2=key2`)。
4. 提交生成的提示。
然后,Claude Desktop 将与其他 MCP 服务器通信以运行 Runbook。
# 可用于运行 Runbook 的示例 MCP 服务器
- [GitHub](https://github.com/github/github-mcp-server)
- [Slack](https://github.com/modelcontextprotocol/servers/tree/main/src/slack)
- [DesktopCommanderMCP](https://github.com/wonderwhy-er/DesktopCommanderMCP)
- 网络搜索和浏览器自动化([链接](https://modelcontextprotocol.io/examples#web-and-browser-automation))
- Kubernetes。有多个实现(例如,[mcp-k8s-go](https://github.com/strowk/mcp-k8s-go))
# 开发计划
- 不再将 Runbook 内容保存在数据库中,而是保存为文件。这便于编辑。人们也可以使用 GitHub 进行版本控制。
- Runbook 模板 X,根据给定输入实例化。
- 可能不需要。用户只需在运行 Runbook 时添加额外的提示。
- 保存执行日志(用于审计和改进)
- 删除机密
- 如果有帮助,还可以将过去的日志传递给 Runbook 提示
- 审批流程。
- 添加工具 `request_approval`。
- 这会向频道发送 Slack 消息。
- 然后,Runbook MCP 服务器监视频道。如果有人响应(是/否),则继续或返回错误。
- 更好的 Runbook 搜索
- 精确名称匹配不是很好
- 注册到 [Smithery](https://smithery.ai/server/@runbookai/runbook-mcp-server)。
# 可行性不明确的潜在工作项
注意:Claude Desktop 不支持“采样”。这有一些限制。
- 子 Runbook 和可重用执行块
- Rest 端点 + 用于管理 Runbook 的前端。
- 能够编辑 Runbook(具有版本控制)
- 显示 Runbook X 的执行计划(dry-run)
- 限制 MCP 服务器和工具
- 将以前的对话转换为 Runbook
- 微调。
- 能够改进 Runbook。如果有成功的执行,请将其保存为示例并提供给 Claude。
- 定期执行
- 能够为运行 MCP 服务器提供环境(VM,docker)。
<a href="https://glama.ai/mcp/servers/p3mq5xzyof">
<img width="380" height="200" src="https://glama.ai/mcp/servers/p3mq5xzyof/badge" alt="Claude Desktop Commander MCP 服务器" />
</a>
[](https://mseep.ai/app/runbookai-runbook-mcp-server)