Skip to main content
Glama

Set private port security groups

set_private_port_security_groups
DestructiveIdempotent

Replace the complete customer-group list for a VPSnet private port to set which security groups apply; use an empty list for the network default.

Instructions

Replace the port's complete customer-group list. Empty list selects the network default; at most seven customer groups fit alongside platform DNS. Use policy and port generations separately. Poll get_network_security_policy for each affected network (policies[].network_id); these receipts are not generic network operation IDs. 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. Read current capabilities and owned resource state first; obtain approval for the exact change. An accepted operation is pending, not proof of connectivity. Poll the returned operation/resource on its in_progress flag, waiting next_check_seconds between reads: while in_progress is true its reason_code is what is awaited (reason_kind waiting, e.g. a queued or pending reason, or a control plane that has not answered yet), never an error; only in_progress false with reason_kind failure is a failure. Preserve reason_code. On transport uncertainty inspect state and reuse only the original key and unchanged request; never automatically retry.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
port_idYesExact lowercase UUID returned by an owned networking resource
group_idsYes
network_idYesExact lowercase UUID returned by an owned networking resource
project_idYesExact lowercase UUID returned by an owned networking resource
idempotencyKeyYesIdempotency-Key for this exact change; preserve it and the unchanged body on uncertain recovery
expected_generationYes
expected_port_generationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.16

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds substantial operational context: explicit networking:read or networking:manage permissions, backend ownership and 2FA enforcement, the fact that an accepted operation is pending rather than proof of connectivity, and a detailed polling protocol using in_progress and reason_code. It also explains transport-uncertainty recovery and warns against automatic retries, which is exactly the behavioral disclosure needed for a mutation tool.

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 description is front-loaded with the core action and then proceeds through prerequisites, operation semantics, and recovery guidance in a logical order. It is long, but the complexity of polling and idempotency warrants most of the detail. A few sentences, especially around polling semantics, could be tightened without losing meaning.

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

Completeness5/5

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

Given a 7-parameter mutation tool with no output schema, the description covers everything an agent needs: required permissions, preconditions, the exact replacement semantics, operation lifecycle, polling with reason_code interpretation, and idempotency-key handling under uncertainty. It leaves no significant gap for correct invocation.

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 57%, and the description compensates by explaining that group_ids is a complete replacement list, that an empty list selects the network default, and that at most seven groups are allowed. It also clarifies that policy and port generations must be used separately, adding meaning to expected_generation and expected_port_generation, which lack schema descriptions. The remaining parameters are either covered by the schema or reinforced by the idempotency discussion.

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 precise verb and resource: "Replace the port's complete customer-group list." It immediately clarifies scope by noting that an empty list selects the network default and that at most seven customer groups fit, distinguishing port-level group assignment from network-level defaults. An agent can tell exactly what this tool mutates without opening the schema.

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?

Provides clear context for use: replace the port's group list, use an empty list to reset to the network default, and read current capabilities and owned resource state before making changes. It also instructs obtaining approval for the exact change. However, it does not explicitly name alternative tools such as update_network_security_group or set_network_default_security_policy, so the agent must infer when this tool is preferable to siblings.

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