MCP tool catalogue

Towbar exposes 53 purpose-built tools. Names follow towbar_<entity>_<action>; they are independent of REST routes. Discovery filters this catalogue by your key and workspace role. Use MCP setup for connection details and worked examples. Mutation tools carry risk annotations; client approval is still required for consequential actions. Successful calls return structured result data with a matching JSON text fallback. Failures set isError. Inventory and history tools return bounded pages with continuation fields. Histories backed by live inventories are best-effort pages, not snapshot cursors; concurrent changes can shift offsets.

Scout Alerts

Inspect Scout alerts and incidents

towbar_alerts_inspectInspect configured rules, latest evaluations, HTTP check results, destination IDs, and a page of incidents. An active incident is not proof that its notification was delivered. Use returned rule IDs before configuration; use the incident cursor to read older history.Read-only operation. Required permissions: alert.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "state": {
      "default": "active",
      "type": "string",
      "enum": ["active", "resolved", "all"]
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "before": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    },
    "beforeId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "ruleId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "deployableId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "string",
          "const": "server"
        }
      ]
    }
  },
  "required": ["serverId"],
  "additionalProperties": false
}

Create or update a Scout alert

towbar_alerts_configureConfigure a host/workload metric alert or a public HTTP uptime check. Omit ruleId to create; supply an inspected ruleId to replace its settings. Read current settings before updating and preserve settings the user did not request changing. HTTP checks send recurring public requests. Alerts notify all destinations configured on the server on the first qualifying reading, once per incident, and recover when the condition clears. Creating a rule does not send an immediate test.Edit access required. Required permissions: alert.configure.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "enabled": {
      "default": true,
      "type": "boolean"
    },
    "severity": {
      "default": "warning",
      "type": "string",
      "enum": ["warning", "critical"]
    },
    "deployableId": {
      "default": null,
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "condition": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string",
          "enum": [
            "cpuPercent",
            "cpuCores",
            "cpuLimitCores",
            "memoryUsedBytes",
            "memoryTotalBytes",
            "memoryLimitBytes",
            "memoryPercent",
            "swapUsedBytes",
            "swapTotalBytes",
            "diskTotalBytes",
            "diskUsedBytes",
            "diskPercent",
            "dockerDiskTotalBytes",
            "dockerDiskUsedBytes",
            "dockerDiskPercent",
            "diskReadBytesPerSecond",
            "diskWriteBytesPerSecond",
            "networkRxBytesPerSecond",
            "networkTxBytesPerSecond",
            "uptimeSeconds",
            "load1",
            "load5",
            "load15",
            "restarts",
            "missingReports",
            "httpAvailability"
          ]
        },
        "http": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "maxLength": 2048,
              "format": "uri"
            },
            "method": {
              "default": "GET",
              "type": "string",
              "enum": ["GET", "HEAD"]
            },
            "intervalSeconds": {
              "default": 60,
              "type": "integer",
              "minimum": 30,
              "maximum": 300,
              "multipleOf": 30
            },
            "timeoutSeconds": {
              "default": 5,
              "type": "integer",
              "minimum": 1,
              "maximum": 10
            },
            "expectedStatusMin": {
              "default": 200,
              "type": "integer",
              "minimum": 100,
              "maximum": 599
            },
            "expectedStatusMax": {
              "default": 299,
              "type": "integer",
              "minimum": 100,
              "maximum": 599
            },
            "maxRedirects": {
              "default": 0,
              "type": "integer",
              "minimum": 0,
              "maximum": 3
            }
          },
          "required": ["url"],
          "additionalProperties": false
        },
        "operator": {
          "default": "above",
          "type": "string",
          "enum": ["above", "below"]
        },
        "threshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000000000000
        },
        "windowSeconds": {
          "default": 300,
          "type": "integer",
          "minimum": 60,
          "maximum": 3600
        },
        "aggregation": {
          "default": "average",
          "type": "string",
          "enum": ["average", "peak"]
        }
      },
      "required": ["metric", "threshold"],
      "additionalProperties": false
    },
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "ruleId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Scout alert rule UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["name", "condition", "serverId"],
  "additionalProperties": false
}

Remove a Scout alert rule

towbar_alerts_removeDelete an inspected Scout rule, stop its checks/evaluation and close active incidents without claiming recovery. Resolved incident history remains until retention expires. Confirm the user’s intended rule before removal.Edit access required. Required permissions: alert.configure.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "ruleId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Scout alert rule UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["serverId", "ruleId"],
  "additionalProperties": false
}

Deployments

Compare performance between deployments

towbar_deployment_compareFirst call with workloadId only to discover successful deployment IDs. Then supply baselineId and candidateId from the same workload and production/preview environment to compare equal post-readiness windows. Reports coverage, usage deltas, restarts and caveats; insufficient data cannot establish a regression and traffic may differ. Defaults to summaries; includePoints returns at most 24 representative points per side.Read-only operation. Required permissions: alert.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "baselineId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Baseline deployment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "candidateId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Compared deployment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "windowMinutes": {
      "default": 30,
      "type": "integer",
      "minimum": 5,
      "maximum": 1440
    },
    "warmupMinutes": {
      "default": 2,
      "type": "integer",
      "minimum": 0,
      "maximum": 60
    },
    "regressionPercent": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 500
    },
    "minimumCoveragePercent": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "statistic": {
      "default": "average",
      "type": "string",
      "enum": ["average", "peak"]
    },
    "cpuFloorCores": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 1024
    },
    "memoryFloorMiB": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 1048576
    },
    "includePoints": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": ["workloadId"],
  "additionalProperties": false
}

List deployment history

towbar_deployment_listFind deployment IDs and outcomes across the workspace with server-side pagination. Use towbar_deployment_inspect for build steps and logs.Read-only operation. Required permissions: deployment.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "default": 1,
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "additionalProperties": false
}

Inspect deployment progress and logs

towbar_deployment_inspectDiagnose one deployment: returns state, build steps, a bounded log page, and optional vulnerability findings. Poll using nextAfter, including after terminal state if hasMoreLogs. Only succeeded, succeeded_with_warnings, failed, cancelled, or skipped are terminal; accepted/queued is not success.Read-only operation. Required permissions: deployment.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "deploymentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Deployment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "after": {
      "default": -1,
      "type": "integer",
      "minimum": -1,
      "maximum": 9007199254740991
    },
    "logLimit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    },
    "includeFindings": {
      "default": false,
      "type": "boolean"
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["deploymentId"],
  "additionalProperties": false
}

Cancel deployment

towbar_deployment_cancelRequest cancellation of a running deployment. Poll towbar_deployment_inspect until terminal; a cancellation request can race completion.Edit access required. Required permissions: deployment.cancel.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "deploymentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Deployment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["deploymentId"],
  "additionalProperties": false
}

Retry deployment

towbar_deployment_retryCreate a new attempt for an eligible failed deployment. Use a fresh idempotencyKey for this retry, then inspect the returned deployment ID.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "deploymentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Deployment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": ["deploymentId", "idempotencyKey"],
  "additionalProperties": false
}

Rescan deployed image

towbar_deployment_rescanRequest a vulnerability scan for a deployment image. Read findings and scan state using towbar_deployment_inspect with includeFindings afterward.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "deploymentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Deployment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["deploymentId"],
  "additionalProperties": false
}

Integrations

List available integrations

towbar_integration_listList integrations enabled by the Towbar runtime environment. Configuration and secret values are never returned.Read-only operation. Required permissions: integration.manage.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Disconnect GitHub integration

towbar_github_disconnectDisconnect the workspace GitHub integration, affecting repository sync and deployments. Confirm this workspace-wide change with the user.Edit access required. Required permissions: integration.manage.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Retry preview reporting

towbar_github_retry_reportingRetry failed GitHub preview status/comment reporting. This retries reporting, not deployment; inspect preview/deployment state separately.Edit access required. Required permissions: integration.manage.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Workspace

Inspect workspace

towbar_workspace_inspectIdentify the current team, actor, and permitted actions. Use first to understand the authenticated context.Read-only operation. Required permissions: identity.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Refresh control-plane health

towbar_workspace_checkRun system health checks, then use towbar_workspace_inspect to review the latest results.Edit access required. Required permissions: system.manage.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Discovery

Find apps, resources, sources, or servers

towbar_inventory_searchFind entity UUIDs by name, repository, or IP before taking action. Returns a compact page and nextOffset. An optional sourceId or serverId limits app/resource discovery; do not supply both. Use the matching inspect tool for details.Read-only operation. Required permissions: repository.read, workload.read, resource.read, server.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource", "source", "server"]
    },
    "search": {
      "default": "",
      "type": "string",
      "maxLength": 255
    },
    "sourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["kind"],
  "additionalProperties": false
}

Find available GitHub or GitLab repositories

towbar_repository_searchFind a repository connection and provider-specific identifier for towbar_source_connect. GitHub uses its installation connection; GitLab uses its workspace provider configuration and supports cloud or self-managed instances.Read-only operation. Required permissions: githubInstallation.read, integration.manage.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "provider": {
      "default": "github",
      "type": "string",
      "enum": ["github", "gitlab"]
    },
    "integration": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "search": {
      "default": "",
      "type": "string",
      "maxLength": 255
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "additionalProperties": false
}

Repositories

Inspect source and environments

towbar_source_inspectInspect a connected repository, its environment branch mappings, auto-deploy control and server capacity. Supply an environmentId to include the immutable manifest snapshot from its latest successful sync. Find IDs with towbar_inventory_search and the returned environment list.Read-only operation. Required permissions: repository.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "environmentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source environment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["sourceId"],
  "additionalProperties": false
}

Connect repository

towbar_source_connectConnect a repository after discovery, mapping its selected environments to branches. Initial sync does not deploy. Inspect each returned environment sync outcome.Edit access required. Required permissions: repository.connect.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "repositoryOwner": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "repositoryName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "environments": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "environment": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9-]{0,62}$"
              },
              "branch": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              }
            },
            "required": ["environment", "branch"],
            "additionalProperties": false
          }
        },
        "provider": {
          "default": "github",
          "type": "string",
          "const": "github"
        },
        "githubInstallationId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        }
      },
      "required": [
        "repositoryOwner",
        "repositoryName",
        "environments",
        "githubInstallationId"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "repositoryOwner": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "repositoryName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "environments": {
          "minItems": 1,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "environment": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9-]{0,62}$"
              },
              "branch": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              }
            },
            "required": ["environment", "branch"],
            "additionalProperties": false
          }
        },
        "provider": {
          "type": "string",
          "const": "gitlab"
        },
        "providerRepositoryId": {
          "type": "string",
          "pattern": "^[1-9]\\d{0,19}$"
        },
        "integration": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
        }
      },
      "required": [
        "repositoryOwner",
        "repositoryName",
        "environments",
        "provider",
        "providerRepositoryId",
        "integration"
      ],
      "additionalProperties": false
    }
  ]
}

Disconnect source

towbar_source_disconnectRemove a source from Towbar. Inspect the source and confirm the target with the user first; this changes which repository Towbar manages.Edit access required. Required permissions: repository.disconnect.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["sourceId"],
  "additionalProperties": false
}

Discover repository environments

towbar_source_discoverRead towbar.yml on a discovery branch to find declared environments before connecting. Does not create a source or deploy.Edit access required. Required permissions: repository.connect.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "repositoryOwner": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "repositoryName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "discoveryBranch": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "provider": {
          "default": "github",
          "type": "string",
          "const": "github"
        },
        "githubInstallationId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        }
      },
      "required": [
        "repositoryOwner",
        "repositoryName",
        "discoveryBranch",
        "githubInstallationId"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "repositoryOwner": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "repositoryName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "discoveryBranch": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "provider": {
          "type": "string",
          "const": "gitlab"
        },
        "providerRepositoryId": {
          "type": "string",
          "pattern": "^[1-9]\\d{0,19}$"
        },
        "integration": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
        }
      },
      "required": [
        "repositoryOwner",
        "repositoryName",
        "discoveryBranch",
        "provider",
        "providerRepositoryId",
        "integration"
      ],
      "additionalProperties": false
    }
  ]
}

Sync connected environments

towbar_source_syncSync one environment when environmentId is supplied, or all connected environments otherwise. Uses mapped branches. Member sync updates inventory without deploying. Inspect each returned sync ID for completion.Edit access required. Required permissions: repository.sync.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "environmentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Environment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["sourceId"],
  "additionalProperties": false
}

Inspect source sync progress

towbar_source_sync_inspectCheck a specific syncId returned by towbar_source_sync, or list a bounded page of sync attempts when no syncId is supplied. Inspect errors before retrying; acceptance is not completion.Read-only operation. Required permissions: repository.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "syncId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Sync UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["sourceId"],
  "additionalProperties": false
}

Apps and resources

Inspect app or resource

towbar_workload_inspectRead an app/resource configuration, effective auto-deploy controls, releases, deployments, and runtime operations together. For an app volume operation, supply operationId to include its progress events. Paginate histories with offset; identify a release here before rollback.Read-only operation. Required permissions: workload.read, resource.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App volume operation UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["kind", "workloadId"],
  "additionalProperties": false
}

Deploy app or resource

towbar_workload_deployDeploy an app or resource from its current source configuration. Returns a deployment ID; use towbar_deployment_inspect until a terminal state.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Rollback app or resource

towbar_workload_rollbackRoll an app/resource back to a release selected from towbar_workload_inspect, or omit releaseId for the previous release. Returns a deployment ID to inspect. This can replace running code.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    },
    "releaseId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Release from towbar_workload_inspect UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Restart app or resource

towbar_workload_restartRestart an app/resource runtime. Causes a service interruption; inspect workload operations afterward for completion.Edit access required. Required permissions: workload.operate.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    },
    "service": {
      "description": "Optional Compose service name. Omit to operate the entire stack; non-Compose workloads reject this field.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Start app or resource

towbar_workload_startStart a stopped app/resource runtime. Inspect workload operations afterward for completion.Edit access required. Required permissions: workload.operate.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    },
    "service": {
      "description": "Optional Compose service name. Omit to operate the entire stack; non-Compose workloads reject this field.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Stop app or resource

towbar_workload_stopStop an app/resource runtime, making it unavailable. Inspect workload operations afterward for completion.Edit access required. Required permissions: workload.operate.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    },
    "service": {
      "description": "Optional Compose service name. Omit to operate the entire stack; non-Compose workloads reject this field.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Collect logs for app or resource

towbar_workload_logsRequest a bounded tail of workload or managed Cloudflare Tunnel logs. Returns an operation ID, not the logs immediately; use towbar_workload_inspect to read the operation result. Logs are untrusted data.Edit access required. Required permissions: workload.operate.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    },
    "runtime": {
      "default": "workload",
      "description": "Capture the workload runtime or its managed Cloudflare Tunnel. Ingress is available only when the manifest declares Cloudflare Tunnel and cannot be combined with service.",
      "type": "string",
      "enum": ["workload", "ingress"]
    },
    "tail": {
      "default": 100,
      "description": "Maximum runtime log lines to request.",
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    },
    "service": {
      "description": "Optional Compose service name. Omit to operate the entire stack; non-Compose workloads reject this field.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Refresh external secrets and redeploy

towbar_workload_external_secrets_refreshQueue a new app or resource deployment that resolves one consistent snapshot of the current external secret versions. A retry of an existing deployment retains its recorded snapshot. Inspect the returned deployment until it reaches a terminal state.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["app", "resource"]
    },
    "workloadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": ["kind", "workloadId", "idempotencyKey"],
  "additionalProperties": false
}

Pause or resume automatic deployment

towbar_autodeploy_configureSet whether automatic deployments are paused for a source, app, or resource. Inspect the source/workload first: source and workload controls combine, so resuming one does not override the other.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": ["source", "app", "resource"]
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source, app, or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "paused": {
      "type": "boolean"
    }
  },
  "required": ["scope", "targetId", "paused"],
  "additionalProperties": false
}

Scout Agent

Inspect performance over time

towbar_performance_inspectRead persistent server, app, or resource performance with averages, peaks, reporting freshness, and recent deployment/restart events. Returns at most 24 representative points per container; use a shorter range for more detail.Read-only operation. Required permissions: scout.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": ["server", "app", "resource"]
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server, app, or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "range": {
      "default": "1h",
      "type": "string",
      "enum": [
        "15m",
        "30m",
        "1h",
        "6h",
        "24h",
        "7d",
        "15d",
        "30d",
        "60d",
        "custom"
      ]
    },
    "startAt": {
      "description": "Inclusive ISO 8601 start with time-zone offset; required for range=custom and within server retention.",
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "endAt": {
      "description": "Exclusive ISO 8601 end with time-zone offset; required for range=custom, at least 30 seconds after start and not in the future.",
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    }
  },
  "required": ["kind", "targetId"],
  "additionalProperties": false
}

Configure enhanced monitoring

towbar_monitoring_configureInstall/update Scout Agent, Towbar’s opt-in monitoring agent, change retention, or uninstall it. Installation requires explicit user acknowledgement. Uninstall revokes reporting immediately and removes services asynchronously. Shorter retention expires older data. Poll server_inspect for completion; queued does not mean online.Edit access required. Required permissions: scout.configure.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "action": {
      "type": "string",
      "enum": ["install", "uninstall", "retention"]
    },
    "retentionDays": {
      "anyOf": [
        {
          "type": "number",
          "const": 7
        },
        {
          "type": "number",
          "const": 15
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 60
        }
      ]
    },
    "acknowledge": {
      "type": "boolean",
      "const": true
    }
  },
  "required": ["serverId", "action"],
  "additionalProperties": false
}

Servers

Inspect server readiness and capacity

towbar_server_inspectRead server settings, capacity, recent checks, preparation attempts, monitoring, and orphan inventory together. Use before preparation or cleanup. No private credential values are returned.Read-only operation. Required permissions: server.read, scout.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["serverId"],
  "additionalProperties": false
}

towbar_server_registerRegister a workspace server by IP and SSH configuration. Then configure credentials, independently verify/trust its SSH host key, and prepare it. Registration alone does not make the server ready.Edit access required. Required permissions: server.update.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "buildConcurrency": {
      "type": "integer",
      "minimum": 1,
      "maximum": 16
    },
    "previewBuildConcurrency": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4
    },
    "ip": {
      "type": "string"
    },
    "ssh": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string"
        },
        "username": {
          "type": "string",
          "pattern": "^[a-z_][a-z0-9_-]{0,31}$"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        }
      },
      "required": ["username"],
      "additionalProperties": false
    },
    "proxy": {
      "type": "object",
      "properties": {
        "cloudflare": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "const": true
            }
          },
          "required": ["enabled"],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": ["ip", "ssh"],
  "additionalProperties": false
}

Remove server from Towbar

towbar_server_removeStop managing a server and forget stored credentials and host trust. Uninstalls monitoring before forgetting SSH access; this may return pending. Does not terminate the machine or delete running services, Docker objects, or data. Assigned workloads and active operations block removal. Inspect and clean selected orphans first if desired.Edit access required. Required permissions: server.remove.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["serverId"],
  "additionalProperties": false
}

Configure server

towbar_server_configureUpdate server IP, SSH settings, proxy options, and build concurrency. Inspect current settings first; changing connectivity can disrupt deployments.Edit access required. Required permissions: server.update.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "buildConcurrency": {
      "type": "integer",
      "minimum": 1,
      "maximum": 16
    },
    "previewBuildConcurrency": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4
    },
    "ip": {
      "type": "string"
    },
    "ssh": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string"
        },
        "username": {
          "type": "string",
          "pattern": "^[a-z_][a-z0-9_-]{0,31}$"
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535
        }
      },
      "required": ["username"],
      "additionalProperties": false
    },
    "proxy": {
      "type": "object",
      "properties": {
        "cloudflare": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "const": true
            }
          },
          "required": ["enabled"],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": ["serverId", "ip", "ssh"],
  "additionalProperties": false
}

Update server credentials

towbar_server_credentials_updateSet or delete SSH/Cloudflare credentials with the revision from towbar_server_inspect. Values are never returned. Preserve expectedRevision to avoid overwriting concurrent changes.Edit access required. Required permissions: server.credentials.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "expectedRevision": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "set": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024,
        "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 65536
      }
    },
    "delete": {
      "default": [],
      "maxItems": 200,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024,
        "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
      }
    }
  },
  "required": ["serverId", "expectedRevision"],
  "additionalProperties": false
}

Trust SSH host key

towbar_server_trust_hostTrust a server host key only after the user independently verifies its fingerprint. Never auto-trust a fingerprint simply because the server reported it.Edit access required. Required permissions: server.credentials.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "algorithm": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9@._+-]{0,79}$"
    },
    "fingerprint": {
      "type": "string",
      "maxLength": 255,
      "pattern": "^SHA256:.*"
    },
    "publicKey": {
      "type": "string",
      "minLength": 32,
      "maxLength": 16384
    },
    "replaceExisting": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": ["serverId", "algorithm", "fingerprint", "publicKey"],
  "additionalProperties": false
}

Revoke trusted SSH key

towbar_server_revoke_hostRemove a previously trusted server host key. This can prevent subsequent SSH connections; identify hostKeyId in towbar_server_inspect first.Edit access required. Required permissions: server.credentials.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "hostKeyId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Trusted host key UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["serverId", "hostKeyId"],
  "additionalProperties": false
}

Prepare server for workloads

towbar_server_prepareInstall or validate server prerequisites after credentials and host trust are configured. Follow preparation attempts in towbar_server_inspect until ready or failed.Edit access required. Required permissions: server.prepare.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["serverId"],
  "additionalProperties": false
}

Refresh server health

towbar_server_checkRequest a new health/capacity check. Inspect server checks afterward to distinguish a queued request from a completed check.Edit access required. Required permissions: server.update.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["serverId"],
  "additionalProperties": false
}

Clean selected orphaned objects

towbar_server_cleanupDelete only explicitly selected orphan containers, images, or volumes from towbar_server_inspect. Volumes may contain data; confirm the exact inventory with the user before cleanup.Edit access required. Required permissions: server.remove.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "serverId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Server UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "items": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": ["container", "image", "volume"]
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          }
        },
        "required": ["kind", "name"],
        "additionalProperties": false
      }
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": ["serverId", "items", "idempotencyKey"],
  "additionalProperties": false
}

Secrets

Inspect secret names and revisions

towbar_secrets_inspectRead secret bindings, inheritance, and revision metadata for a workspace, source, app, or resource. Never returns plaintext values. Read before towbar_secrets_update; use the correct environment and slot revision.Read-only operation. Required permissions: secret.list, sharedSecret.list.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": ["workspace", "source", "app", "resource"]
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Secret owner; omit for workspace scope UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "environment": {
      "type": "string",
      "maxLength": 80,
      "pattern": "^(?:preview:)?[a-z][a-z0-9-]{0,62}$"
    }
  },
  "required": ["scope"],
  "additionalProperties": false
}

Update environment secrets

towbar_secrets_updateSet/delete named secrets in one environment and lifecycle stage. Use expectedRevision from towbar_secrets_inspect (null only for an empty slot). A conflict requires rereading and reconciling changes. Never returns plaintext values.Edit access required. Required permissions: secret.update, sharedSecret.update.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": ["workspace", "source", "app", "resource"]
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Secret owner; omit for workspace scope UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "environment": {
      "type": "string",
      "maxLength": 80,
      "pattern": "^(?:preview:)?[a-z][a-z0-9-]{0,62}$"
    },
    "stage": {
      "type": "string",
      "enum": ["build", "deployment", "pre_deploy", "post_deploy"]
    },
    "expectedRevision": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "set": {
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024,
        "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 65536
      }
    },
    "delete": {
      "default": [],
      "maxItems": 200,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024,
        "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
      }
    }
  },
  "required": ["scope", "environment", "stage", "expectedRevision"],
  "additionalProperties": false
}

Backups and restores

Inspect backups and restore progress

towbar_backup_inspectFor a source, page through available backups. For a resource, inspect backup assurance and operations; supply operationId to include its restore events. Use before restore and to check backup/restore completion.Read-only operation. Required permissions: repository.read, resource.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": ["source", "resource"]
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Source or resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Resource operation UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["scope", "targetId"],
  "additionalProperties": false
}

Back up resource

towbar_backup_createRequest a database/resource backup. Follow the operation in towbar_backup_inspect; acceptance does not mean a recoverable backup exists.Edit access required. Required permissions: resource.backup.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "resourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": ["resourceId", "idempotencyKey"],
  "additionalProperties": false
}

Restore resource backup

towbar_backup_restoreRestore a selected backup to a resource. This can overwrite database contents. Inspect backup assurance and the target first; obtain the exact confirmation and a reason from the user. Follow progress with towbar_backup_inspect.Edit access required. Required permissions: resource.restore.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "resourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "backupId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "confirmation": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "reason": {
      "type": "string",
      "minLength": 10,
      "maxLength": 1000
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": [
    "resourceId",
    "backupId",
    "confirmation",
    "reason",
    "idempotencyKey"
  ],
  "additionalProperties": false
}

Clean up completed restore

towbar_restore_cleanupRequest cleanup for a specific restore after reviewing its outcome. This removes retained restore artifacts; use towbar_backup_inspect to verify completion.Edit access required. Required permissions: resource.restore.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "resourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "restoreId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Unique identifier for this intended action. Reuse exactly this value when retrying an uncertain response; use a new value for a new action."
    }
  },
  "required": ["resourceId", "restoreId", "idempotencyKey"],
  "additionalProperties": false
}

Cancel restore

towbar_restore_cancelRequest cancellation of an eligible resource restore. Inspect the operation with towbar_backup_inspect afterward; acceptance is not proof that the restore stopped.Edit access required. Required permissions: resource.restore.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "resourceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Resource UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "operationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Restore operation UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["resourceId", "operationId"],
  "additionalProperties": false
}

Preview environments

Find pull request previews

towbar_preview_listList preview environments for an app or source, including IDs, URLs, and lifecycle state. Use IDs from this list for deploy/cleanup, and poll it afterward to verify the outcome.Read-only operation. Required permissions: workload.read, repository.read.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": ["app", "source"]
    },
    "targetId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "App or source UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": ["scope", "targetId"],
  "additionalProperties": false
}

Deploy pull request preview

towbar_preview_deployRequest a deployment for a preview environment found by towbar_preview_list. Inspect the returned deployment ID and preview lifecycle afterward.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "previewEnvironmentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Preview environment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["previewEnvironmentId"],
  "additionalProperties": false
}

Remove pull request preview

towbar_preview_cleanupRequest removal of a preview environment and its runtime. Confirm the selected preview; poll towbar_preview_list afterward until cleanup completes or fails.Edit access required. Required permissions: deployment.create.Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "previewEnvironmentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Preview environment UUID returned by a Towbar discovery or inspection tool. Do not guess IDs."
    }
  },
  "required": ["previewEnvironmentId"],
  "additionalProperties": false
}

Get started

Repositories

Apps

Resources

Servers

Deployments

Previews

Workspace

Integrations

MCP tool catalogue

Scout Alerts

Deployments

Integrations

Workspace

Discovery

Repositories

Apps and resources

Scout Agent

Servers

Secrets

Backups and restores

Preview environments

​Scout Alerts

​Deployments

​Integrations

​Workspace

​Discovery

​Repositories

​Apps and resources

​Scout Agent

​Servers

​Secrets

​Backups and restores

​Preview environments

Scout Alerts

Deployments

Integrations

Workspace

Discovery

Repositories

Apps and resources

Scout Agent

Servers

Secrets

Backups and restores

Preview environments