Skip to main content

WhiteCapData-Dev — an MCP server to operate a k3s / Kubernetes cluster (health, logs, and guarded restart/scale/delete) straight from your AI agent.

Project description

WhiteCapData-Dev

Operate a k3s / Kubernetes cluster straight from your AI agent — safe by default.

CI PyPI Python MCP License: MIT

An MCP server that lets an agent (Claude Code, Claude Desktop, Cursor, …) inspect and operate a Kubernetes / k3s cluster — your homelab box, a dev cluster, whatever your kubeconfig points at — without shelling out to kubectl. It talks to the Kubernetes API directly using your existing kubeconfig (or an in-cluster service account).

The design goal is safe by default: reads are always on; every mutating action (restart / scale / delete) is gated before the API call by a read-only switch and a namespace allowlist, so an over-eager agent can't touch kube-system or nuke a deployment you didn't sandbox.

Name note: the PyPI package is whitecapdata-dev (the homelab-k8s-style name was taken); the import package and tools are k8s/homelab-focused as described here.


Why you'd want this

  • 🩺 One-call health. cluster_summary gives node + pod totals and the unhealthy pods, so the agent starts triage with real data.
  • 🔒 Safe by default. Mutations are blocked unless the namespace is on your allowlist; flip HOMELAB_MCP_READONLY=1 to make the whole server read-only.
  • 🧰 The operations you actually do. Pods, deployments, events, logs, node health, rollout-restart, scale, delete-pod.
  • 🪶 No bespoke backend. Uses the standard Kubernetes API + your kubeconfig — nothing to deploy server-side.
  • Tested. Pure logic is unit-tested with fakes; guard logic is tested against a mocked API. No cluster needed to run the suite.

Requirements

  • A reachable cluster and a working kubeconfig (the same one kubectl uses), or run it in-cluster with a service account.
  • Python 3.11+ (or just uvx).

Install

uvx whitecapdata-dev          # run directly
# or
pip install whitecapdata-dev  # then run: whitecapdata-dev

Claude Code

claude mcp add homelab -- uvx whitecapdata-dev

Claude Desktop / Cursor

{
  "mcpServers": {
    "homelab": {
      "command": "uvx",
      "args": ["whitecapdata-dev"],
      "env": {
        "HOMELAB_MCP_MUTABLE_NAMESPACES": "default,apps,monitoring",
        "HOMELAB_MCP_READONLY": "0"
      }
    }
  }
}

Run with Docker

A Dockerfile is included. The server speaks MCP over stdio and reaches your cluster through a mounted kubeconfig. Run interactively (-i), starting read-only:

docker build -t whitecapdata-dev .
docker run --rm -i \
  -v "$HOME/.kube/config:/home/app/.kube/config:ro" \
  -e HOMELAB_MCP_READONLY=1 \
  whitecapdata-dev

Tools

Tool Kind Description
cluster_summary read Node/pod health totals + unhealthy pods
list_pods read Pods (optionally one namespace), unhealthy first
list_deployments read Deployments with ready/desired replicas
list_events read Recent events, Warnings first
pod_logs read Tail a pod's logs
node_health read Per-node readiness, kubelet, capacity, pressure
restart_deployment write Rollout-restart (allowlisted namespaces)
scale_deployment write Scale to N replicas (0..max, allowlisted)
delete_pod write Delete a pod; its controller recreates it (allowlisted)
server_info read Effective config (context, read-only, allowlist)

Configuration

Variable Default Description
HOMELAB_MCP_CONTEXT current-context kubeconfig context to use
HOMELAB_MCP_READONLY 0 1/true disables all mutating tools
HOMELAB_MCP_MUTABLE_NAMESPACES default,apps,monitoring,ci Namespaces mutations may touch; * = all
HOMELAB_MCP_MAX_REPLICAS 10 Upper bound for scale_deployment

Safety model

  1. Read-only switchHOMELAB_MCP_READONLY=1 rejects every mutating tool up front.
  2. Namespace allowlist — mutating tools refuse any namespace not in HOMELAB_MCP_MUTABLE_NAMESPACES (default a homelab-friendly set; * opts into all).
  3. Bounded scalescale_deployment clamps to 0..HOMELAB_MCP_MAX_REPLICAS.

The cluster's own RBAC still applies on top — this server can only do what the kubeconfig identity is permitted to do.

Development

git clone https://github.com/Michael-WhiteCapData/WhiteCapData-Dev
cd WhiteCapData-Dev
uv pip install -e ".[dev]"
ruff check .
pytest          # no cluster required — APIs are faked/mocked

See CONTRIBUTING.md.

License

MIT © Michael Tierney

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

whitecapdata_dev-0.1.2.tar.gz (137.9 kB view details)

Uploaded Source

Built Distribution

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

whitecapdata_dev-0.1.2-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file whitecapdata_dev-0.1.2.tar.gz.

File metadata

  • Download URL: whitecapdata_dev-0.1.2.tar.gz
  • Upload date:
  • Size: 137.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for whitecapdata_dev-0.1.2.tar.gz
Algorithm Hash digest
SHA256 645a3af398434d820e66c1850c940be4897fdf1de99689e651b1b7f51c48d7e5
MD5 d46a43173c43ea8193f07104e53b508d
BLAKE2b-256 d7359503f03e42de942f49ffe3b7fd5aeddbbd21fc47c4930b004505cfb72973

See more details on using hashes here.

File details

Details for the file whitecapdata_dev-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: whitecapdata_dev-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for whitecapdata_dev-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d1fcfd6f6c75c405f5cf2c1ae54680cbe7b0fbe713f35972da365d4e7ae49b97
MD5 05014a35f7e990220b24cade476821b6
BLAKE2b-256 4259bd6a874d912ba5382d456f3f5b81a113a990b52b9c9d386cf23317278b44

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