Skip to main content
Glama

Deploy the website preview (Restart)

airapps_site_deploy_preview

Uploads the AirApp's current files as the members-only preview (the dashboard's Restart), unless the preview already is this version. outcome: blocked means the files cannot deploy; state.blockers says why. Nothing public changes.

POST /api/v1/airapps/{nodeId}/site/preview

For multi-space accounts, call auth_verify, ask the user which space to use, and pass targetSpaceId. An AirApp's website: after its files change, deploy the members-only preview, then go live to put that same version on the public address. Changes to records need no redeploy.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "nodeId": "<nodeId>"
    },
    "name": "airapps_site_deploy_preview"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodeIdYes
targetSpaceIdNoBusabase space id. Call auth_verify first and ask the user which space to use when more than one is returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Beyond the annotations, it discloses an idempotency guard ('unless the preview already is this version'), the failure contract (`outcome: blocked` with `state.blockers` explaining why), and the blast radius ('Nothing public changes'). It does not say whether the deploy is synchronous or how long it takes, which is the main remaining behavioral gap.

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

Conciseness4/5

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

The core behavior and its non-obvious caveat (already-current version) are front-loaded, followed by the endpoint, then prerequisites and lifecycle context. The third paragraph is dense and mixes prerequisites with lifecycle advice, but every sentence carries usable information.

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 two-parameter mutation with no output schema, the definition covers purpose, prerequisites, idempotency, failure signaling, and next steps. The only gap is the shape of a successful return (the `state` object is referenced but never described).

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

Parameters4/5

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

Schema coverage is only 50%, so the description must compensate: it explains the multi-space flow for targetSpaceId and the endpoint line ('/airapps/{nodeId}/site/preview') clarifies that nodeId is the AirApp node identifier. nodeId itself still gets no explicit definition, keeping it below a 5.

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?

States a concrete verb and resource ('Uploads the AirApp's current files as the members-only preview') and explicitly maps it to the dashboard's 'Restart'. The contrast with go_live ('Nothing public changes') separates it from the public-publish sibling without the agent needing to open either schema.

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?

Gives an explicit sequencing rule: after files change, deploy the preview, then go live to put that same version on the public address. It also names the negative case ('Changes to records need no redeploy') and the multi-space prerequisite (call auth_verify, ask the user which space).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.