Docs
MCP
Model Context Protocol server for AI agents that need to operate Nixploy.
Endpoint
POST /api/mcp on your panel, over streamable HTTP. Authenticate with the same API key as the REST API (x-api-key, or Authorization: Bearer). The transport is stateless, so every request stands alone.
Read-only tools
- list_projects, list_services, list_databases, get_database, list_templates
- get_service_logs, list_deployments, get_deployment_provenance (commit, author, trigger)
- list_rollback_points and list_domains
- get_env and get_resolved_env across organization → project → environment → service
- list_incidents, list_backups, list_backup_runs, list_previews
- get_service_metrics (local and remote Swarm nodes) and get_platform_health
Guarded writes
- deploy / start / stop / restart applications, deploy a compose stack
- rollback_deployment and cancel_deployment
- set_env — merges variables and answers with a key-level diff
- add_domain / remove_domain, run_backup / verify_backup
- acknowledge_incident / resolve_incident
Every tool call runs through the same tRPC routers as the panel, so organization scoping, key scopes and capability checks apply unchanged — an agent can never do more than the key allows. Give one the narrowest scope that does its job: read for an observer, deploy for one that ships. Deleting projects, services or databases is deliberately not exposed, and neither is restoring a backup over live data. 42 tools; full list and client config in docs/mcp.md.
Also see the repository guides under docs/ · REST API reference