Skip to main content
Glama
Sign In
safe-omada-mcp

safe-omada-mcp

by gaspareduard
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

getUrlFilterWhitelist

Get the MAC-based allow (whitelist) filter entries for a site (paginated). Returns MAC addresses explicitly allowed through MAC filtering.

Instructions

Get the MAC-based allow (whitelist) filter entries for a site (paginated). Returns MAC addresses explicitly allowed through MAC filtering.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "getUrlFilterWhitelist"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (1-based).
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.
pageSizeNoNumber of results per page (1–1000).
customHeadersNoOptional HTTP headers to include in the Omada API request (e.g. {"X-Custom-Header": "value"}). Rarely needed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.18.0

TDQS

C2.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries the disclosure burden. It clearly indicates a read-style 'Get' operation, site scoping, pagination, and that the return contains MAC addresses explicitly allowed through MAC filtering, but it does not mention auth/permission needs, rate behavior, or edge cases.

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?

The definition is short, front-loaded, and easy to scan. The second sentence partly repeats the first by restating that MAC addresses are explicitly allowed, but it remains efficient overall.

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?

For a read-only listing tool with four parameters and no output schema, the description covers the resource, site scope, pagination, and return content sufficiently to invoke it. It does not resolve the URL-vs-MAC ambiguity created by the tool name and siblings, which matters for tool selection.

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%, so page, pageSize, siteId, and customHeaders are already documented in the schema. The description only reinforces site targeting and pagination, adding little beyond the structured parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description says it retrieves MAC-based allow/whitelist filter entries for a site, which is a specific verb and resource. However, the tool name is getUrlFilterWhitelist and the sibling set includes getUrlFilterBlacklist and getMacFilterDetail, so an agent may not know whether this is URL filtering or MAC filtering. The name/description mismatch leaves the resource ambiguous.

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?

The description gives no explicit when-to-use guidance, prerequisites, or alternatives. It does not explain when to choose this over getUrlFilterBlacklist, getUrlFilterRules, getMacFilterDetail, or getGridAllowList.

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