homelab-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@homelab-mcpwhat's the current health of the homelab?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Homelab MCP Server
A constrained Model Context Protocol adapter for Homelab Core. It lets an AI assistant inspect health, service verification, redacted logs, nodes, jobs, and correlated job events without editing the deployment repository or opening SSH sessions.
Read tools are the default. Set HOMELAB_MCP_ALLOW_CHANGES=1 only when you want the two job-queuing tools to appear. Those tools still use Core's typed operations, audit trail, queue limits, and idempotency contracts; this server never exposes arbitrary shell, file access, secrets, or raw node tasks.
Local configuration
Run the server where it can see Core's Unix socket and UI transport token. The UI token is the correct least-privilege local credential for diagnostics; do not copy the controller's root-only local token out of its data volume.
{
"mcpServers": {
"homelab": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"--network", "none",
"--read-only",
"--cap-drop", "ALL",
"--security-opt", "no-new-privileges:true",
"--volume", "homelab_controller-socket:/run/homelab-controller:ro",
"--env", "HOMELAB_CONTROLLER_SOCKET=/run/homelab-controller/controller.sock",
"--env", "HOMELAB_CONTROLLER_TOKEN_FILE=/run/homelab-controller/ui.token",
"--env", "HOMELAB_CONTROLLER_ROLE=ui",
"ghcr.io/breixopd/homelab-mcp:1.0.0"
]
}
}
}The example volume name is the default managed deployment name. If a Compose
project prefix was customized, replace it with the actual controller-socket
volume. The MCP process needs no network access: all traffic stays on the local
Unix socket. Token files are read in place, never copied into command arguments
or MCP responses.
Related MCP server: homelab-ai
Tools
homelab_get_overviewhomelab_list_serviceshomelab_get_service_diagnosticshomelab_get_service_verificationhomelab_list_nodeshomelab_list_jobshomelab_get_jobhomelab_get_job_eventshomelab_run_service_verification(changes enabled only)homelab_run_maintenance(changes enabled only)
Build and test
npm ci
npm run check
docker build --pull -t homelab-mcp:test .The initial transport is stdio. A remote HTTP listener is intentionally absent until Core provides a dedicated scoped observer credential; exposing the full local/UI controller token over a network would be the wrong security boundary.
This server cannot be deployed
Maintenance
Related MCP Connectors
Read-only MCP server: let AI agents read your ORANO saved-video library, tasks, and memory.
Read-only MCP for AI usage profiles, leaderboards, stats, and docs; no writes or private data.
Personal assistant MCP server with search, execute, packages, jobs, secrets, and integrations.
Read-only MCP server exposing a user ORANO library to their own AI agent.
Related MCP Servers
- AlicenseAqualityBmaintenanceProvides a set of read-only Kubernetes functions via an MCP server, enabling interaction with Kubernetes clusters through agents or coding assistants like GitHub Copilot.9266 PyPI3Apache 2.0
- AlicenseNot gradedqualityAmaintenanceSelf-hosted AI orchestrator that monitors and manages homelab services, exposing them as MCP tools for LLMs to drive.2MIT
- AlicenseAqualityCmaintenanceMCP server — read-only log access for AI assistants. Debug your Linux server with AI, without giving the AI shell access.75MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that gives AI assistants real-time access to your homelab infrastructure. It enables querying node status, managing Docker containers, controlling Proxmox VMs, and inspecting OPNsense firewall state through natural conversation.2MIT