Skip to main content
Glama

getGridGatewayRule

Read-only

Retrieves paginated URL filter gateway rules for a specified Omada site, helping you inspect URL-based filtering applied to gateway traffic.

Instructions

Get the URL filter gateway rules (paginated). Returns URL-based filtering rules applied to traffic through the gateway.

Input Schema

NameRequiredDescriptionDefault
pageNoStart page number. Start from 1.
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.
pageSizeNoNumber of entries per page. Range: 1-1000.

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 results are paginated and describes the subject matter of the returned rules, but says nothing about ordering, default scope, or how many rules typically exist beyond what the schema states.

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?

Two short, front-loaded sentences with no filler. The second sentence partially restates the first ('URL filter gateway rules' vs 'URL-based filtering rules applied to traffic through the gateway'), but the cost is minimal.

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 simple, fully-annotated read tool with complete schema documentation, the definition is adequate but thin. With no output schema present, the description could have sketched the rule fields returned or clarified site scoping, which it leaves entirely to the schema's siteId text.

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%, with page, pageSize, and siteId all documented in the schema including defaults, ranges, and the listSites discovery hint. The description's only parameter-relevant contribution is the word 'paginated', 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 gives a specific verb and resource ('Get the URL filter gateway rules') and confirms it is paginated, so an agent knows what is being fetched. However, it never distinguishes this from close siblings such as getUrlFilterRules, getGridEapRule, or getGridAllowList/getGridBlockList, leaving the 'Grid/Gateway' naming ambiguous relative to the URL-filter family.

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 guidance is offered: there is no statement about which sibling to call for EAP-level rules versus gateway-level rules, nor for allow-list/block-list variants. Usage can only be inferred from the phrase 'applied to traffic through the gateway'.

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