Skip to main content
Glama

getUrlFilterGeneral

Read-only

Retrieve a site's URL filtering global settings, including whether filtering is enabled and the default action for unmatched requests, to verify current web access policy.

Instructions

Get the URL filter global setting, including whether URL filtering is enabled and the default action for unmatched requests.

Input Schema

NameRequiredDescriptionDefault
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.0-rc.1

TDQS

A3.8/5.0
Behavior4/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 and the description only needs to add context. It does add value by naming the two pieces of state returned (enabled flag and default action for unmatched requests), which matters because there is no output schema; it does not, however, discuss whether this reads a per-site or fleet-wide config beyond the 'global' wording.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence that front-loads the resource being fetched and then specifies its contents. There is no filler, repetition of the tool name, or trailing qualification.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter, read-only getter with no output schema, the description is adequate: it identifies the resource and the return fields, and the schema handles the siteId semantics. It falls short only in not tying the tool to its sibling URL-filter endpoints, which an agent would need in order to route correctly.

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?

There is a single optional siteId parameter with 100% schema description coverage, and the schema already explains the OMADA_SITE_ID fallback and points to listSites. The description adds nothing about the parameter, so the baseline of 3 applies since the schema carries the full burden.

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 uses a specific verb and resource ('Get the URL filter global setting') and enumerates what the setting contains ('whether URL filtering is enabled and the default action for unmatched requests'). However, it never distinguishes this from closely named siblings such as getUrlFilterRules, getUrlFilterBlacklist, and getUrlFilterWhitelist, leaving the agent to infer that this one is the global toggle/state rather than a rule list.

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 by the word 'global' — an agent can guess this is the site-level on/off and default-action state rather than the per-rule endpoints. There is no explicit statement of when to call this versus getUrlFilterRules or the blacklist/whitelist tools, and no prerequisites or exclusions are given.

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