Skip to main content

Runbook MCP server

Project description

Runbook.AI

Claude Desktop Commander MCP server

Runbook MCP Server

Runbook MCP Server enables you to run your own runbooks from Claude Desktop.

  • Run ops runbooks (e.g., deploy a service, upgrade a Kubernetes cluster)
  • Run manual test plans (e.g., create a new EC2 instance, ssh into the instance, and run the integration test there).

Please watch the demo video below to understand how it works!

demo

How to Use

Step 1. Start the MCP server with Claude Desktop.

Create config.yaml

Put the following configuration to claude_desktop_config.json.

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

Step 2. Create runbooks

You can use markdown files or text files as runbooks. See examples.

We support env/var substitution.

Define env.yaml.

env:
  key: value
  • {env[key]} is replaced with value.
  • {var.name} is replaced with a variable value.

Rebuild the index when files are updated.

You can also create a new runbook, use the create_runbook tool. Here is an example prompt:

Example 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.

Step 3. Run runbooks

To run a runbook, take the following steps:

  1. Click "Attach from MCP" from Claude Desktop.
  2. Select get_runbook_as_prompt from the list of integrations.
  3. Pass the name of the runbook you would like to execute. Also specify variables with a comma-separated list (e.g., var1=key1,var2=key2).
  4. Submit the generated prompt.

Then Claude Desktop will talk to other MCP servers to run the runbook.

Example MCP Servers that can be used to Run Runbooks

Development Plan

  • Instead of saving the content of the runbook in the database, just save as a file. This helps easy editting. People can also simply use GitHub for versioning.
  • Runbook template X that is instantiated with given inputs.
    • Maybe this is not needed. A user just needs to put additional prompts when running the runbook.
  • Save executing log (for auditting and refinement)
    • Remove secrets
    • Also pass a past log to the runbook prompt if this helps better execution
  • Approval flow.
    • Add a tool request_approval.
    • This sends a slack message to a channel.
    • Then the Runbook MCP server watches the channel. If someone responds (yes / no), it proceeeds or returns an error.
  • Better runbook search
    • The exact name match is not great
  • Registrtation to Smithery.

Potential Work Items where its Feasibility is not clear

Note: Claude Desktop does not support "Sampling". This puts some limitations.

  • Sub-runbook and reusable execution block
  • Rest endpoint + frontend for managing runbooks.
  • Be able to edit the runbook (with versioning)
  • show an execution plan for runbook X (dry-run)
    • Restrict MCP servers and tools
  • convert a previous conversation into a runbook
  • fine-tuning.
  • Be able to refine a runbook. If there is a successful execution, save it as an example and give it to Claude.
  • Periodic execution
  • Be able to provision an environment (VM, docker) for running MCP servers.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_runbook_mcp_server-0.1.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_runbook_mcp_server-0.1.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file mseep_runbook_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: mseep_runbook_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_runbook_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fbfe65d4403762c3587c3fb3388183131b5760d77603e4ca68a03573f83dd2b0
MD5 1a710f70481c596f7dc1c5427af5ac80
BLAKE2b-256 69d77220b0130d733c357622b578163c2874667ca19a30c4840b9efeb3bcc899

See more details on using hashes here.

File details

Details for the file mseep_runbook_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mseep_runbook_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a28c9c8c130b7420f7cd0024353c0bc8ee5038f2457bd53b2cdd7585dcd3a68d
MD5 4ec857c361665fa3850cc09587d7e75b
BLAKE2b-256 79f71d5d5213673095047a837883e108674cfa15c32c50a9f2eb9cf3a051b614

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page