Skip to main content
Glama

getMacFilterDetail

Read-only

Retrieves a site's MAC filtering global settings, showing whether filtering is enabled and the default action for unmatched clients.

Instructions

Get the MAC filtering global settings for a site, including whether MAC filtering is enabled and the default action for unmatched clients.

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.

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 adds that the settings are 'global' for a site and names the two values returned, which is useful behavioral context, but it says nothing about pagination, error behavior when MAC filtering is unconfigured, or what other fields come back.

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 sentence that front-loads the resource and then enumerates the returned values, with no filler or redundancy. It could be marginally tighter only by routing to a sibling, not by cutting any existing clause.

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 one-parameter, zero-required, read-only getter with full schema coverage and no output schema, the description supplies enough to call it correctly and to know roughly what comes back. The only meaningful gap is not situating it among the many ACL/allow-list siblings, which matters given how many near-neighbors exist.

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% and the siteId parameter is documented thoroughly, including the config fallback and a pointer to listSites. The description adds nothing about siteId, so it neither compensates nor detracts; the baseline of 3 applies since the schema does all the work for the single parameter.

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 gives a specific verb ('Get') and resource ('MAC filtering global settings') and enumerates the two pieces of information returned (enabled flag, default action for unmatched clients). It is clear what the tool retrieves, though it never names or distinguishes itself from the ACL/allow-list/block-list siblings (getGridAllowList, getOswAclList, getAclConfigTypeSetting), so an agent must infer which MAC-control tool to pick.

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 guidance, no prerequisites, and no mention of the closely related ACL/allow-list tools in the sibling set. The read-only nature is only implied by the word 'Get', leaving the agent to infer that this is a configuration-inspection call rather than a policy-management call.

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