Skip to main content
Glama

getGridEapRule

Get the URL filter AP rules (paginated). Returns URL-based filtering rules applied to wireless clients via access points.

Instructions

Get the URL filter AP rules (paginated). Returns URL-based filtering rules applied to wireless clients via access points.

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

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

B3.2/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 burden; it does disclose that results are paginated, which is useful behavioral context. However, it omits permission/auth requirements, the default-site resolution behavior, and any indication of output shape or error conditions beyond what the schema shows.

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 sentences, front-loaded with the core action. The second sentence partially restates the first but does add the useful detail that rules apply to wireless clients via access points; minor redundancy but no filler.

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?

With 0 required parameters, a fully documented schema, and no output schema, the description covers the basics for a read tool. It still lacks routing guidance among the densely clustered filter siblings and any return-shape hint, leaving a gap an agent would notice.

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 coverage is 100%, with page/pageSize/siteId/customHeaders fully documented in the schema, so the baseline is 3. The description's only added semantic ('paginated') aligns with page/pageSize but contributes nothing beyond what the schema already explains.

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 the URL filter AP rules') and clarifies these are URL-based filtering rules applied to wireless clients via access points, which resolves the cryptic 'EapRule' name. It does not explicitly differentiate from close siblings like getUrlFilterRules, getUrlFilterBlacklist, or getUrlFilterWhitelist, so the agent must infer 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 Guidelines2/5

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

The description gives no when-to-use guidance, no exclusions, and never names an alternative. Given the many overlapping URL/ACL filter siblings, an agent has no basis for choosing this tool over getUrlFilterRules or listEapAcls beyond guesswork.

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