Skip to main content
Glama

network_vlans

Read-only

List appliance VLANs configured on a Meraki network to inspect subnet and appliance IP assignments by network ID, with optional target selection.

Instructions

[READ] Appliance VLANs configured on a network (id, subnet, appliance IP).

Args:
    network_id: Meraki network id (from network_list).
    target: Target name from config; omit for the default.

Input Schema

NameRequiredDescriptionDefault
targetNo
network_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so safety is covered. The description reinforces this with the [READ] tag and lists returned fields, but discloses nothing about permissions, rate limits, or pagination.

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?

Front-loads the [READ] marker and resource, then an Args block. Every line earns its place; only the empty title line adds nothing.

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 simple two-parameter read tool with annotation-covered safety and no output schema, the description supplies the essential return fields, parameter provenance, and the target default. Pagination or result-count behavior is the only minor omission.

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 0%, so the description must compensate, and it does: network_id is described as a Meraki network id sourced 'from network_list', and target is described as a config target name whose omission selects the default. This adds real meaning beyond the bare 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?

States a specific verb via the [READ] marker and a specific resource (Appliance VLANs configured on a network), plus the fields returned (id, subnet, appliance IP). The [READ] prefix separates it from the write sibling update_network_vlan, though that sibling is never named.

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 explicit when-to-use or when-not guidance, and no alternative is named despite update_network_vlan being the obvious companion. The only contextual hint is 'omit for the default' for the target parameter.

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