Skip to main content
Glama

Get network appliance operation

get_network_appliance_operation
Read-onlyIdempotent

Poll a network appliance operation until it succeeds, fails, or is cancelled, waiting between status reads as a load balancer or VPN change settles.

Instructions

Poll an accepted appliance operation on in_progress (true until succeeded, failed or cancelled), waiting next_check_seconds between reads (a load balancer or VPN change settles in a few seconds). A fresh change is queued with appliance_dispatch_pending and then waiting_dependency while the control plane answers; reason_kind waiting marks every such reason as progress, not an error. Creation succeeds only when its actual resource state and health confirm readiness. Requires explicit networking:read for reads or networking:manage for changes; full/read defaults do not grant networking. The backend enforces ownership, feature availability and service 2FA locks.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operation_idYesExact lowercase UUID returned by an owned networking resource

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.16

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already declare the safe read-only, idempotent profile, yet the description adds substantial context beyond them: poll cadence, the meaning of waiting reason_kind, the rule that creation only succeeds when resource state and health confirm readiness, and the permission model (networking:read vs networking:manage, defaults insufficient). It also notes backend enforcement of ownership, feature availability and 2FA locks.

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 purpose is front-loaded in the first clause and every sentence carries operational information about states, timing, or permissions. It is dense and semi-colon-heavy, but there is no filler or repetition of the title.

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?

With no output schema, the description must carry the return-value burden, and it does: it names the status progression and the terminal states an agent should test against. It stops short of describing the full response shape or which fields confirm readiness, leaving a small gap for a polling tool.

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?

The single operation_id parameter is fully documented in the schema (UUID pattern, length bounds, ownership note), giving 100% coverage, so the baseline is 3. The description adds only an implicit 'owned' qualifier and no additional syntax or sourcing detail beyond the schema.

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

Purpose4/5

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

The description states a specific verb and resource: polling an accepted appliance operation, with the terminal states spelled out (succeeded, failed, cancelled). It is clearly a status-read tool rather than a mutator. However, it never distinguishes itself from the close sibling get_networking_operation, leaving the agent to infer the scope difference from the name alone.

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

Usage Guidelines4/5

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

It gives concrete usage context: poll while on in_progress, wait next_check_seconds between reads, and treat queued/waiting_dependency as progress rather than failure. What is missing is an explicit statement of when to choose this over get_networking_operation or list_networking_operations, so alternatives remain unaddressed.

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

Deploy Server

Other Tools