Skip to main content
Glama

getUrlFilterRules

Read-only

Retrieve paginated gateway URL filter rules for a site to review URL allow/block policies applied at the gateway.

Instructions

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

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).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.0-rc.1

TDQS

B3.4/5.0
Behavior3/5

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

The readOnlyHint=true and destructiveHint=false annotations already establish the safety profile, so the description need not restate it. It adds useful context that results are paginated and scoped to a gateway/site, but says nothing about ordering, total counts, or what a rule entry contains, and with no output schema that leaves gaps.

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 with no filler, and the core purpose plus pagination is front-loaded before the explanatory gloss. Slightly dense parenthetical insertion, but nothing that could be cut without losing 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?

For a read-only, three-parameter listing tool with full schema coverage and no output schema, the description covers purpose and scoping adequately. What is missing is the routing information an agent needs in a crowded gateway/filter sibling set: when this combined listing is preferred over the blacklist, whitelist, and general-config tools.

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, and siteId are already fully documented, including the OMADA_SITE_ID default and the pointer to listSites. The description's only contribution is the word 'paginated', which merely flags that the schema's paging parameters matter. 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?

The description pairs a specific verb (Get) with a specific resource (gateway URL filter rules) and adds scope (for a site, paginated) plus a gloss on what the resource means (URL-based allow/block rules applied on the gateway). It only implicitly differentiates from the close siblings getUrlFilterBlacklist and getUrlFilterWhitelist by implying a combined allow/block listing rather than stating the distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: an agent can infer this is the read path for URL filter rules on a gateway. There is no explicit when-to-use versus when-not, and no naming of the obvious alternatives (getUrlFilterBlacklist, getUrlFilterWhitelist, getUrlFilterGeneral) that a caller would need to choose between.

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