Skip to main content
Glama

Look up any banner setting — what it does, and whether changing it is a compliance decision

help.explainConfigKey

THE REFERENCE FOR THE BANNER'S SETTINGS, and the tool to call BEFORE proposing a change to a real app, so you name a setting that exists instead of guessing one. Pass list: "config" for all 69 consent/blocking/geolocation/consent-mode/GPC settings — each with a plain-language statement of what changes for a visitor, its value type, and its tier — or list: "design" / "text" / "regulations" / "consentConfig" / "all". Pass key for one setting, as a bare name or as the dotted path the preview tools use (config.blocking, config.regulations.gdpr, text.bodyText). It tells you WHICH pair of account.* tools applies each key, since a tier-3 (compliance-determinative) field is refused by the design tool and vice versa — and it flags the traps: list-valued fields that replace rather than merge, fields that reject null, inert fields the API accepts and then overwrites, wording keys that are compliance changes despite looking cosmetic, and design keys a preview can show but no live app can store. Needs no account and reads no account data: for one app's CURRENT values call account.getDesign (authenticated — see help.explainTokenSetup).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNoOne key to explain. Accepts a bare name (`blocking`, `bodyText`, `bannerBackground`) or a dotted path exactly as the preview tools take it (`config.blocking`, `config.regulations.gdpr`, `design.primaryColor`, `text.bodyText`, `consentConfig.*`). Every match is returned when a bare name exists in more than one vocabulary.
listNoEnumerate a whole vocabulary instead of explaining one key: `config` (the 69 BannerConfigJSON settings, each with its tier and consequence), `regulations`, `consentConfig`, `design`, `text`, `snippet` (the huOptions keys that go in the page, including `blocking`), or `all`. Use this to find out WHICH setting does what you want before naming one — start with `config` for anything about consent categories, geolocation, consent mode or GPC.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations supplied, the description carries the full burden and handles it well: it states the tool reads no account data, requires no authentication, and returns definitions, types, and safety warnings like 'fields that are refused' and 'fields that are inert.' This makes the side-effect-free and informational nature unmistakable.

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?

The description is long, but every clause adds distinct value: purpose, parameters, return content, traps, and an alternative tool. The all-caps emphasis and colon-led lists keep it scannable despite its density.

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

Completeness5/5

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

Covers purpose, invocation modes, parameter format, return content, authentication, side effects, and related tools. The only minor gap is not explicitly saying `key` and `list` are mutually exclusive, but the phrasing makes that strongly inferable.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already documents the `key` and `list` parameters, but the description adds meaningful semantics: it explains the 69-field scope, the bare vs. dotted path accepted forms, and what each list variant returns. It does not fully state whether the two parameters are mutually exclusive, but the message strongly implies it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear statement of what the tool is and when to use it: 'THE REFERENCE FOR THE BANNER'S SETTINGS' and 'the tool to call BEFORE proposing a change.' It immediately distinguishes itself from account.getDesign by saying it exists to avoid inventing nonexistent settings.

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

Usage Guidelines5/5

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

It gives explicit routing: use `list` for vocabularies, `key` for a single setting, and account.getDesign when you need live account values instead. This is actionable guidance that tells the agent exactly when and how to invoke the tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources