Skip to main content
Glama

getGridGatewayRule

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

Instructions

Get the URL filter gateway rules (paginated). Returns URL-based filtering rules applied to traffic through 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": "getGridGatewayRule"
  }
}

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.
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 full behavioral burden. It does disclose that results are paginated and that the payload is URL-based filtering rules applied to gateway traffic, which is useful. It says nothing about read-only semantics (only implied by "Get"), required permissions, or default ordering, so coverage is partial.

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 compact sentences with the resource named first and the return content second; no filler. It could still be tighter by folding the two clauses together, but nothing wastes space.

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?

Without annotations or an output schema, the description should compensate with sibling disambiguation and safety cues for a read tool with 4 optional params. Parameters are fully schema-documented, but the crowding with other URL-filter list tools is unaddressed, leaving a real selection gap.

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, siteId (including listSites discovery and OMADA_SITE_ID fallback) and customHeaders all documented in the schema. The description adds no parameter meaning beyond the parenthetical "(paginated)", so baseline 3 applies.

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 names a specific verb and resource ("Get the URL filter gateway rules") and mentions pagination, but the sibling set contains many near-identical URL-filtering tools (getUrlFilterRules, getGridAllowList, getGridBlockList, getGridEapRule). Apart from the implicit gateway-vs-EAP split, nothing tells an agent how this differs from those siblings.

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 when-to-use guidance, no prerequisites, and no named alternative. An agent choosing between getUrlFilterRules and getGridGatewayRule gets no routing signal from this description.

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