Skip to main content
Glama

getUrlFilterRules

Get gateway URL filter rules for a site (paginated), listing URL-based allow/block rules applied on the gateway.

Instructions

Get gateway URL filter rules for a site (paginated), listing URL-based allow/block rules applied on the gateway.

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": "getUrlFilterRules"
  }
}

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
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses pagination and that results are allow/block rules, but says nothing about ordering, whether allow and block rules are merged in one list, what the default page size behavior means, or whether the call requires gateway-specific licensing/permissions.

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 front-loaded sentence with no filler; the resource and pagination constraint come first. It is efficient, though it spends its short length on restating scope rather than on differentiating information.

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?

A read-only list tool with four fully documented parameters and no output schema, so the description is largely sufficient for invocation. It still leaves the return shape and how allow versus block rules are represented unexplained, which matters for a tool whose whole purpose is reading a rule list.

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%, including the siteId fallback to OMADA_SITE_ID and the listSites discovery hint, so the schema does the heavy lifting. The description only echoes 'for a site (paginated)' and adds no syntax or semantics beyond that, so the baseline 3 is appropriate.

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 and resource (get gateway URL filter rules for a site) and characterizes the content as URL-based allow/block rules applied on the gateway. It does not, however, distinguish itself from close siblings such as getUrlFilterBlacklist, getUrlFilterWhitelist, or getUrlFilterGeneral, so an agent cannot tell from the description alone which of those 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?

No when-to-use or when-not guidance and no named alternatives, despite four closely related URL-filter tools in the sibling list. The only routing signal is the implicit 'gateway' scoping, which the agent must infer.

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