Skip to main content
Glama
hugil
by hugil

get_pvids

Retrieve the PVID (port VLAN ID) for every port on a Zyxel GS1900 switch to audit or document VLAN assignments.

Instructions

Get the PVID (port VLAN ID) for every port.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the behavioral burden, but as a zero-argument read getter there is little to disclose. It does not mention whether ALL ports are always returned (e.g. ports without a PVID), which is the one behavioral detail an agent might want.

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?

A single front-loaded sentence with zero waste, expanding the acronym inline. Nothing extraneous and nothing important deferred.

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 parameters and an output schema present, the description only needs to convey scope and identity, which it does. The main residual gap is the absence of any sibling comparison, but return-value detail is rightly left to the output schema.

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?

The tool takes no parameters, so there is nothing to document; the baseline for a zero-parameter schema is 4. The description correctly implies the breadth of the result rather than a filtered lookup.

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?

States a specific verb (get) and resource (PVID for every port), and expands the acronym so an agent knows exactly what comes back. It does not differentiate itself from read siblings such as get_vlan_membership, which also expose VLAN-related port data, so it falls short of a 5.

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?

There is no guidance on when to call this versus get_vlan_membership or list_vlans, nor any prerequisite noted. Usage is only implied by the read-oriented 'Get' verb.

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