MCP server for Beaker lab automation — system provisioning, job management, distro discovery, and failure diagnosis
Project description
mcp-beaker
MCP server for Beaker lab automation -- system provisioning, job management, distro discovery, and failure diagnosis.
Works with any Beaker server instance. Built on FastMCP v3 and designed for use with AI coding assistants (Cursor, Claude Desktop, etc.).
Features
- 23 tools covering the full Beaker lifecycle: systems, jobs, distros, tasks
- Flexible auth: Kerberos (native GSSAPI/SPNEGO or
bkrCLI fallback) and password (XML-RPC) - Job XML validation: auto-fills missing fields, infers distro families
- Failure diagnosis: deep analysis with auto-retry on correctable failures
- 10 documentation topics exposed as MCP resources
- 2 workflow prompts for common tasks (reserve system, diagnose job)
- Generic: works with any Beaker URL, configurable SSL/CA settings
Installation
Container (recommended)
The container image bundles krb5-devel and gssapi so there are no host
dependencies beyond podman (or docker) and a valid Kerberos ticket.
# Pull the pre-built image from GHCR
podman pull ghcr.io/faizbawa/mcp-beaker:latest
# Or build locally from the repo
podman build -t mcp-beaker:latest -f Containerfile .
Pip / uvx
# Using uv (recommended)
pip install uv
uvx mcp-beaker
# Using pip
pip install mcp-beaker
mcp-beaker
# With native Kerberos support (no bkr CLI needed -- requires krb5-devel on host)
pip install mcp-beaker[kerberos]
# Local development
uv run --directory /path/to/mcp-beaker mcp-beaker
Configuration
Cursor / VS Code
Add to your .cursor/mcp.json (or .vscode/mcp.json):
Container (recommended)
{
"mcpServers": {
"beaker": {
"command": "podman",
"args": [
"run", "--rm", "-i", "--pid=host",
"-v", "/run/.heim_org.h5l.kcm-socket:/run/.heim_org.h5l.kcm-socket",
"-v", "/etc/krb5.conf:/etc/krb5.conf:ro",
"-v", "/etc/krb5.conf.d:/etc/krb5.conf.d:ro",
"-v", "/etc/crypto-policies:/etc/crypto-policies:ro",
"-v", "/etc/pki:/etc/pki:ro",
"-v", "/var/lib/sss/pubconf/krb5.include.d:/var/lib/sss/pubconf/krb5.include.d:ro",
"-e", "BEAKER_URL=https://beaker.example.com",
"-e", "BEAKER_AUTH_METHOD=kerberos",
"-e", "BEAKER_KERBEROS_BACKEND=http",
"-e", "KRB5CCNAME=KCM:",
"ghcr.io/faizbawa/mcp-beaker:latest"
]
}
}
}
The volume mounts forward the host Kerberos ticket (KCM cache) and TLS
certificates into the container. Run kinit on the host before starting.
Pip / uvx
{
"mcpServers": {
"beaker": {
"command": "uvx",
"args": ["mcp-beaker[kerberos]"],
"env": {
"BEAKER_URL": "https://beaker.example.com",
"BEAKER_AUTH_METHOD": "kerberos",
"BEAKER_KERBEROS_BACKEND": "http"
}
}
}
}
Streamable HTTP mode
uvx mcp-beaker --transport streamable-http --port 8000
{
"mcpServers": {
"beaker": {
"url": "http://localhost:8000/mcp",
"type": "streamableHttp"
}
}
}
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
BEAKER_URL |
Yes | -- | Base URL of your Beaker server |
BEAKER_AUTH_METHOD |
No | kerberos |
kerberos or password |
BEAKER_KERBEROS_BACKEND |
No | http |
http (native SPNEGO) or bkr (bkr CLI) |
BEAKER_USERNAME |
For password auth | -- | Beaker username |
BEAKER_PASSWORD |
For password auth | -- | Beaker password |
BEAKER_OWNER |
No | $USER |
Default owner for job queries |
BEAKER_SSL_VERIFY |
No | true |
Verify SSL certificates |
BEAKER_CA_CERT |
No | -- | Path to CA certificate bundle |
CLI Options
mcp-beaker [OPTIONS]
Options:
--transport [stdio|sse|streamable-http] Transport type (default: stdio)
--port INTEGER Port for HTTP transports (default: 8000)
--host TEXT Host for HTTP transports (default: 0.0.0.0)
--path TEXT Path for streamable-http (default: /mcp)
--beaker-url TEXT Beaker server URL
--ssl-verify / --no-ssl-verify Verify SSL certs (default: verify)
--ca-cert TEXT CA certificate bundle path
--auth-method [kerberos|password] Authentication method
--kerberos-backend [http|bkr] Kerberos backend (default: http)
--read-only Disable all write tools
--enabled-tools TEXT Comma-separated tools to enable
-v, --verbose Increase verbosity (-v info, -vv debug)
--version Show version
--help Show this message
Tools
Read Tools (13)
| Tool | Description |
|---|---|
list_systems |
List systems by availability (all/available/free) |
get_system_details |
Hardware specs, ownership, status for a system |
get_system_history |
Activity history for a system |
get_system_arches |
Supported OS families and architectures |
list_jobs |
Filter jobs by owner, status, whiteboard |
get_job_status |
Job status with failure diagnosis |
get_job_results_xml |
Export job results as XML |
get_job_logs |
List log files for a job/recipe/task |
list_distro_trees |
Search distros by name, family, arch, tags |
list_os_families |
List all known OS families |
whoami |
Show authenticated user info |
list_lab_controllers |
List all lab controllers |
search_tasks |
Search the task library |
Write Tools (10)
| Tool | Description |
|---|---|
submit_job |
Submit a job from XML (with validation and auto-fill) |
clone_job |
Clone and resubmit an existing job |
cancel_job |
Cancel a running/queued job |
watch_job |
Poll until completion with failure analysis and auto-retry |
reserve_system |
Manually reserve a system |
release_system |
Release a manually reserved system |
power_system |
Power on/off/reboot a system |
provision_system |
Provision a reserved system with a distro |
extend_watchdog |
Extend a running task's watchdog timer |
set_job_response |
Ack/nak (waive) a recipe set result |
Authentication
Kerberos (recommended)
Ensure you have a valid ticket:
kinit your-username@YOUR.REALM
The server supports two Kerberos backends, controlled by BEAKER_KERBEROS_BACKEND:
| Value | Backend | Install |
|---|---|---|
http (default) |
Native GSSAPI/SPNEGO -- lightweight, pip-installable | pip install mcp-beaker[kerberos] |
bkr |
bkr CLI subprocesses -- traditional, requires RPM |
yum install beaker-client |
Both backends use the same Kerberos ticket from kinit.
Password
Set BEAKER_AUTH_METHOD=password along with BEAKER_USERNAME and BEAKER_PASSWORD. The server authenticates via the XML-RPC auth.login_password() method. Note: this requires server-side LDAP to be enabled.
Architecture
src/mcp_beaker/
__init__.py # Click CLI entry point
config.py # BeakerConfig dataclass
exceptions.py # Custom exceptions
client.py # BeakerClient (XML-RPC + REST)
models/ # Pydantic response models
servers/
__init__.py # FastMCP server, lifespan, DI helper
systems.py # System tools (4 read + 4 write)
jobs.py # Job tools (4 read + 6 write)
distros.py # Distro tools (2 read)
tasks.py # Task tools (1 read)
general.py # General tools (2 read)
prompts.py # Workflow prompt templates
resources.py # Beaker documentation resources
utils/
xml_validation.py # Job XML validation/auto-fill
diagnosis.py # Failure analysis engine
formatting.py # Human-readable formatters
bkr_cli.py # bkr CLI helpers
parsing.py # ID parsing utilities
Development
cd mcp-beaker
uv sync --dev
uv run pytest
uv run ruff check src/
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_beaker-0.2.1.tar.gz.
File metadata
- Download URL: mcp_beaker-0.2.1.tar.gz
- Upload date:
- Size: 145.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9347144eb74118d268514b98623ec810e5e199a688e7120271ca97cdc71657f9
|
|
| MD5 |
e000baea6239eb64956f0092a3964703
|
|
| BLAKE2b-256 |
2fae7f56de5e9b3867327aaef8f73b6886e4ba9b403963f01e22b3b91b4a4600
|
File details
Details for the file mcp_beaker-0.2.1-py3-none-any.whl.
File metadata
- Download URL: mcp_beaker-0.2.1-py3-none-any.whl
- Upload date:
- Size: 48.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a9bae9d568653fc9d17fcf81bb59d0dbb30523a963addfa147d51bb4f6c7c3f8
|
|
| MD5 |
3cb43d83eac6ec9a0ee4ef0bc7aca73d
|
|
| BLAKE2b-256 |
919fa446717b1c8010eab733ae9548b78b2a38877f8667a725043c89dd1d476e
|