Skip to main content
Glama

getSitesGatewaysPin

Read-only

Retrieve an LTE gateway's PIN setting by MAC address, optionally within a site, to inspect or verify gateway configuration.

Instructions

Get PIN setting for a gateway (LTE model).

Input Schema

NameRequiredDescriptionDefault
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.
gatewayMacYesMAC address of the gateway (e.g. "AA-BB-CC-DD-EE-FF"). Use listDevices to find gateway MACs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.0-rc.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description contributes the LTE-model applicability constraint, which is not in the annotations, but adds nothing about permissions, error behaviour, or what the PIN value represents (device PIN vs SIM PIN).

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?

A single short sentence with the resource front-loaded and no filler. It is efficient, though the terseness comes at the cost of context rather than being maximally informative.

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

Completeness3/5

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

This is a simple two-parameter read with no output schema and covered annotations, so the description does not need to explain return values. However, it leaves the key ambiguity of what a gateway "PIN setting" actually is, which matters for an agent deciding whether this is the right 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?

Schema description coverage is 100%: siteId's default-site fallback and gatewayMac's format plus the listDevices discovery hint are all documented in the schema. The description adds no meaning beyond that, so the baseline 3 applies.

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 uses a specific verb and resource ("Get PIN setting for a gateway") and adds a scoping qualifier ("LTE model") that separates it from the many other getSitesGateways* siblings. It does not explicitly name a neighbouring alternative, but the resource is narrow enough that an agent can identify what it retrieves.

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-to-use guidance, and no alternatives are named. The parenthetical "(LTE model)" is an implied applicability constraint but it is never stated as a rule, leaving the agent to infer that non-LTE gateways are out of scope.

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