Skip to main content
Glama

ensure_port_forward_rule

Set up or modify a port forwarding rule to route external traffic to an internal IP, controlling protocol, ports, and source.

Instructions

Create or update a port forwarding rule

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fwdYesInternal IP address
srcYesSource IP (usually "any")
nameYes
protoYes
enabledYes
dst_portYesExternal port
fwd_portYesInternal port

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations are absent, so the description carries the full disclosure burden. 'Create or update' does reveal an idempotent upsert behavior, which is useful, but it stops short of stating what identifies an existing rule (match key), whether an existing rule is overwritten, or what happens on conflicting field values. For a mutation tool with zero annotation coverage, this is under-disclosed.

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?

Six words, zero filler, and the action verb is front-loaded. It is maximally scannable and every word earns its place; the only deduction is that the extreme terseness is achieved by sacrificing usage and behavioral detail that other dimensions have to supply.

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

Completeness2/5

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

For a 7-required-parameter mutation tool with no annotations and no output schema, a single sentence is inadequate. Critical operational facts are missing: how 'ensure' resolves an existing rule, whether it can create, update, or both by name, what conflicts do, and what the call returns. The surrounding get/update/delete_port_forward_rule sibling family makes this omission more consequential for agent decision-making.

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 coverage is 57%, with fwd, src, proto, dst_port, and fwd_port already documented meaningfully — including the practical 'usually any' hint on src. The description adds no parameter-level information and does not compensate for the undocumented name and enabled fields, though those are fairly self-explanatory. Moderate schema coverage keeps this at baseline.

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 pair ('Create or update') attached to a concrete resource ('port forwarding rule'), and the 'ensure' naming convention is honored by revealing the upsert semantics. It clearly distinguishes from get_port_forward_rules and delete_port_forward_rule, though the overlap with update_port_forward_rule is never resolved explicitly.

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

Usage Guidelines2/5

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

No guidance is given on when to prefer this tool over update_port_forward_rule, which is a near sibling whose existence creates genuine ambiguity. The description neither states the condition that selects the ensure path nor mentions any prerequisites or exclusions, leaving the agent to guess which operation is intended.

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