Runbook Mcp Server

🚀 Runbook.AI运行手册服务器

Runbook.AI运行手册服务器允许您借助Claude Desktop来运行自己的运行手册。它能助力您执行各类操作运行手册，像部署服务、升级Kubernetes集群等；还能执行手动测试计划，例如创建新的EC2实例，通过ssh登录该实例并开展集成测试。

下面是演示视频，助您直观了解其工作原理！

🚀 快速开始

📦 安装指南

第一步：使用Claude Desktop启动MCP服务器

创建config.yaml，并把以下配置添加到claude_desktop_config.json中：

{
"mcpServers": {
"runbook": {
"command": "uv",
"args": [
"--directory",
"/runbook-mcp-server",
"run",
"runbook_server.py"
]
}
}
}

第二步：创建运行手册

您既可以使用Markdown文件，也能使用文本文件作为运行手册，具体可参考示例。我们支持环境/变量替换，您需要定义env.yaml：

env:
key: value

• {env[key]} 会被替换为 value。
• {var.name} 会被替换为变量值。 当更新文件时，需要重建索引。此外，您还能使用create_runbook工具来创建新的运行手册，以下是示例提示： 示例1

创建一个新的运行手册：

- name: list_pods
- content: 列出所有命名空间中的Pod，找到未就绪的Pod，并将这些信息发送到Slack。

您不需要解释内容。只需将其传递给工具。

第三步：执行运行手册

若要运行运行手册，请按以下步骤操作：

1. 在Claude Desktop中点击“从MCP附加”。
2. 选择get_runbook_as_prompt（来自集成列表）。
3. 传递您希望执行的运行手册名称，同时指定变量，使用逗号分隔列表（例如var1=key1,var2=key2）。
4. 提交生成的提示。

之后Claude Desktop会与其他MCP服务器通信，以执行运行手册。

💻 使用示例

基础用法

在创建运行手册时，可参考如下示例提示：

创建一个新的运行手册：

- name: list_pods
- content: 列出所有命名空间中的Pod，找到未就绪的Pod，并将这些信息发送到Slack。

您不需要解释内容。只需将其传递给工具。

高级用法

在执行运行手册时，可指定变量，示例如下：

传递运行手册名称时，指定变量，如 var1=key1,var2=key2

📚 详细文档

可用于运行运行手册的示例MCP服务器

• GitHub
• Slack
• DesktopCommanderMCP
• 网页搜索和浏览器自动化（链接）
• Kubernetes。有几个实现（例如mcp-k8s-go）

开发计划

• 不再将运行手册内容保存到数据库，而是以文件形式保存，这样便于编辑，也能使用GitHub进行版本控制。
• 运行手册模板X，可通过给定输入进行实例化，但可能不需要此功能，用户可直接在运行时传递额外的提示。
• 保存执行日志（用于审核和优化）
  • 移除机密信息。
  • 若有助于更好地执行，可将过去的日志传递到运行手册提示中。
• 批准流程
  • 添加工具request_approval。
  • 该工具会向Slack频道发送一条消息。
  • 然后Runbook.AI MCP服务器会监视该频道，若有人回复（是 / 否），则继续执行或返回错误。
• 优化运行手册搜索功能，精确名称匹配效果不佳。
• 注册到Smithery。

可能的工作项，其可行性尚不明确

注意：Claude Desktop 不支持“采样”，这存在一定限制。

• 子运行手册和可重用执行块。
• 带有前端的REST端点（用于管理运行手册）。
• 支持编辑运行手册（带版本控制）。
• 显示运行手册X的执行计划（演练），同时限制MCP服务器和工具。
• 将之前的对话转换为运行手册。
• 精细调整。
• 可通过成功执行来优化运行手册，若有成功执行案例，将其保存为示例并传递给Claude。
• 支持定期执行。
• 能够 provisioning环境（VM、docker）以运行MCP服务器。