Skip to main content
Glama

Generate Deploy Plan

clawops_plan
Read-onlyIdempotent

Generate a deploy plan as reviewable JSON to preview infrastructure changes before applying. Approve what would be created before committing to deployment.

Instructions

Generate a Maker deploy plan (does NOT apply). Plan is JSON conforming to deploy-plan.schema.json — review before applying.

Use when: the user wants to see what would be created before committing, or you (the agent) need a reviewable artifact for the user to approve.

Do NOT use when: the user has explicitly asked to deploy and you already have their approval — go directly to clawops_up.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
regionNoCloud region, in the provider's own spelling (us-east-1, us-central1, eastus). Omitted = the region recorded for the stack
outPathNoAbsolute path to write plan; if omitted, plan returned inline
sshCidrNoCIDR(s) allowed to reach SSH, comma-separated, or 'auto' for this machine. Omitted = none, and nothing will be able to connect
providerNoCloud to plan against. Omitted = the provider recorded for the stack. 'local' has no plan/apply path and is refused
stackNameNoWhich stack the plan is for. Omitted = the default stack in ~/.clawops/config.json
gatewayCidrNoCIDR(s) allowed to reach the gateway port, or 'auto'. Requires publishGateway=all
privateOnlyNoClose public SSH and gateway access; reach the stack over its tailnet. Requires a verified tailnet address (clawops_harden with tailscale), and refuses unless that address answers SSH now
instanceTypeNoA clawops alias (micro|small|medium|large|gpu) or a machine type the cloud names itself, e.g. t3.small
publishGatewayNoWhich interface the gateway binds. loopback (default) keeps it off the network
openclawVersionNosemver, or 'stable'/'dev'

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.1.3
    • addedInput schema / properties / gatewayCidr / description
      Added value: +"CIDR(s) allowed to reach the gateway port, or 'auto'. Requires publishGateway=all"
    • addedInput schema / properties / instanceType / description
      Added value: +"A clawops alias (micro|small|medium|large|gpu) or a machine type the cloud names itself, e.g. t3.small"
    • addedInput schema / properties / openclawVersion / description
      Added value: +"semver, or 'stable'/'dev'"
    • addedInput schema / properties / outPath / description
      Added value: +"Absolute path to write plan; if omitted, plan returned inline"
    • addedInput schema / properties / privateOnly / description
      Added value: +"Close public SSH and gateway access; reach the stack over its tailnet. Requires a verified tailnet address (clawops_harden with tailscale), and refuses unless that address answers SSH now"
    • addedInput schema / properties / provider / description
      Added value: +"Cloud to plan against. Omitted = the provider recorded for the stack. 'local' has no plan/apply path and is refused"
    • addedInput schema / properties / publishGateway / description
      Added value: +"Which interface the gateway binds. loopback (default) keeps it off the network"
    • addedInput schema / properties / region / description
      Added value: +"Cloud region, in the provider's own spelling (us-east-1, us-central1, eastus). Omitted = the region recorded for the stack"
    • addedInput schema / properties / sshCidr / description
      Added value: +"CIDR(s) allowed to reach SSH, comma-separated, or 'auto' for this machine. Omitted = none, and nothing will be able to connect"
    • addedInput schema / properties / stackName / description
      Added value: +"Which stack the plan is for. Omitted = the default stack in ~/.clawops/config.json"
  2. First observedv2.1.1

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds meaningful behavior beyond that: 'does NOT apply', output is JSON conforming to an external schema, and the artifact is meant for review before application. It does not disclose minor operational details like auth requirements, but those are less critical for a read-only plan tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact, front-loaded with the core purpose, and each sentence earns its place. The 'Use when' and 'Do NOT use when' structure is scannable and gives the agent direct decision rules without wasted text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 10-optional-parameter planning tool, the schema covers all parameters and the description covers output format ('JSON conforming to deploy-plan.schema.json') and the decision boundary for when to use it. It is slightly less self-contained because the referenced schema is not inline, and the distinction between clawops_up and clawops_apply is not elaborated, but nothing essential is missing for correct selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and every parameter already has a detailed description, including defaults, omitted behavior, and refusal cases. The tool description itself does not add parameter-level meaning, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource: 'Generate a Maker deploy plan' and immediately clarifies the key distinction that it 'does NOT apply'. This differentiates it from apply/up siblings without requiring the agent to inspect any other tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly states when to use it ('when the user wants to see what would be created before committing') and when not to use it ('user has explicitly asked to deploy... go directly to clawops_up'). This is model guidance with a named alternative.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.