Runbook MCP Server

Runbook MCP Server

Runbook MCP Server 可让你通过 Claude Desktop 运行自己的运维手册。

• 运行运维手册（例如，部署服务、升级 Kubernetes 集群）
• 运行手动测试计划（例如，创建新的 EC2 实例，ssh 登录该实例，并在那里运行集成测试）。

请观看下方的演示视频，了解其工作方式！

如何使用

第 1 步：通过 Claude Desktop 启动 MCP 服务。

创建 config.yaml

将以下配置放入 claude_desktop_config.json。

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

第 2 步：创建运维手册

你可以使用 Markdown 文件或文本文件作为运维手册。请参阅示例。

我们支持 env/var 替换。

定义 env.yaml。

env:
  key: value

• {env[key]} 会被替换为 value。
• {var.name} 会被替换为变量值。

文件更新后，请重新构建索引。

你也可以创建新的运维手册，使用 create_runbook 工具。以下是一个提示词示例：

示例 1

Create a new runbook:

- name: list_pods
- content: List pods in all namespaces, find pods that are not ready, and send that to Slack.

You don't need to interpret the content. Please just pass it to the tool.

第 3 步：运行运维手册

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

1. 在 Claude Desktop 中点击“Attach from MCP”。
2. 从集成列表中选择 get_runbook_as_prompt。
3. 传入要执行的运维手册名称。也请使用逗号分隔的列表指定变量（例如，var1=key1,var2=key2）。
4. 提交生成的提示词。

然后 Claude Desktop 会与其他 MCP 服务通信，以运行该运维手册。

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

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

开发计划

• 不再将运维手册的内容保存在数据库中，而是直接保存为文件。这有助于轻松编辑。用户也可以 直接使用 GitHub 进行版本管理。
• 运维手册模板 X，根据给定输入实例化。
  • 这可能没有必要。用户只需在运行运维手册时添加额外的提示词。
• 保存执行日志（用于审计和改进）
  • 移除机密信息
  • 如果有助于更好地执行，也将过往日志传入运维手册提示词
• 审批流程。
  • 添加一个工具 request_approval。
  • 向某个频道发送 Slack 消息。
  • 然后 Runbook MCP server 监控该频道。如果有人回复（yes / no），则继续执行或返回错误。
• 改进运维手册搜索
  • 精确名称匹配效果不佳
• 注册到 Smithery。

可行性尚不明确的潜在工作项

注意：Claude Desktop 不支持“Sampling”。这带来了一些限制。

• 子运维手册和可复用的执行块
• 用于管理运维手册的 Rest 接口 + 前端。
• 能够编辑运维手册（支持版本管理）
• 展示运维手册 X 的执行计划（试运行）
  • 限制 MCP 服务和工具
• 将先前的对话转换为运维手册
• 微调。
• 能够改进运维手册。如果执行成功，将其保存为示例 并提供给 Claude。
• 定期执行
• 能够为运行 MCP 服务配置环境（VM、docker）。