使用说明

项目简介

Runbook MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，它允许用户创建和管理 Runbook。Runbook 本质上是预定义的任务或流程，可以被 Claude Desktop 等 MCP 客户端调用执行。该服务器主要用于扩展 Claude Desktop 的自动化能力，支持运维操作、手动测试计划等场景。

主要功能点

Runbook 管理: 提供 Runbook 的创建、删除和检索功能。用户可以定义 Runbook 的名称和内容，内容以文本形式描述任务步骤。
Runbook 执行: 通过 MCP 协议，Claude Desktop 可以请求服务器获取 Runbook 内容，并将其作为 Prompt 提供给 LLM 执行，从而实现自动化任务。
Prompt 模板: 'get_runbook_as_prompt' 工具可以将指定的 Runbook 内容转换为 Prompt 模板，方便 LLM 理解和执行。
本地存储: Runbook 数据存储在本地 SQLite 数据库中。

安装步骤

克隆仓库: 将 GitHub 仓库 'https://github.com/runbookai/runbook-mcp-server' 克隆到本地。

git clone https://github.com/runbookai/runbook-mcp-server
cd runbook-mcp-server

安装 Python 依赖: 虽然仓库中没有明确的依赖文件，但根据代码推测，可能需要安装 'mcp-server-fastapi' 或 'mcp-server' 以及其他依赖。建议使用 'uv' 或 'pip' 安装。

# 建议使用 uv (如果已安装 uv):
uv pip install mcp-server-fastapi  # 或 mcp-server
# 如果使用 pip:
pip install mcp-server-fastapi  # 或 mcp-server

配置数据库 (可选): 默认配置使用 './config.yaml' 文件中的数据库设置。如果需要自定义数据库 URI 或 migration 目录，请修改 'config.yaml' 文件。

服务器配置

要将 Runbook MCP Server 连接到 Claude Desktop，需要在 Claude Desktop 的配置文件 'claude_desktop_config.json' 中添加以下服务器配置。

{
  "mcpServers": {
    "runbook": {
      "command": "uv",
      "args": [
        "--directory",
        "<Runbook MCP Server 仓库的绝对路径>",
        "run",
        "runbook.py"
      ]
    }
  }
}

配置参数说明:

'command': 指定用于启动服务器的命令。这里示例使用 'uv'，您也可以使用 'python' 或其他 Python 运行器。
'args': 启动命令的参数列表，用于配置服务器的运行方式。
- '--directory': 指定 Runbook MCP Server 仓库的绝对路径。请将 '<Runbook MCP Server 仓库的绝对路径>' 替换为您实际克隆仓库的本地路径。
- 'run': 如果 'command' 使用 'uv'，则使用 'run' 子命令来运行 Python 脚本。如果 'command' 使用 'python'，则不需要此参数。
- 'runbook.py': 指定服务器主程序文件为 'runbook.py'。

注意: 请务必将 '<Runbook MCP Server 仓库的绝对路径>' 替换为 Runbook MCP Server 仓库在您电脑上的实际绝对路径。

基本使用方法

启动 Runbook MCP Server: 在 Runbook MCP Server 仓库目录下，运行以下命令启动服务器。

uv run runbook.py  # 或 python runbook.py

配置 Claude Desktop: 打开或创建 'claude_desktop_config.json' 文件（通常位于 Claude Desktop 的配置目录下），并将上面提供的服务器配置添加到 'mcpServers' 字段中。
连接 MCP 服务器: 在 Claude Desktop 中，点击 "Attach from MCP" 按钮。
选择集成: 在弹出的集成列表中，选择 "get_runbook_as_prompt"。
输入 Runbook 名称: 输入您想要执行的 Runbook 的名称。
提交 Prompt: Claude Desktop 将生成一个 Prompt，点击提交后，Claude Desktop 将与 Runbook MCP Server 交互，获取 Runbook 内容并执行。

创建和管理 Runbook

使用 'create_runbook' 工具 (Tool) 创建新的 Runbook。可以通过 Claude Desktop 或其他 MCP 客户端调用该工具，并提供 Runbook 的名称和内容。
使用 'delete_runbook' 工具 (Tool) 删除已有的 Runbook。
使用 'list_runbooks' 资源 (Resource) 获取所有 Runbook 的列表。
使用 'get_runbook' 资源 (Resource) 获取指定名称 Runbook 的详细信息。

关键词