Skip to main content
Glama

configure_inapp_banner

Idempotent

Configure and publish on-site in-app popups or banners (center modal, top bar, bottom card) to show promotions or announcements to active website visitors without browser notification permission.

Instructions

Configure and publish an on-site In-App Popup or Banner (center modal, top sticky bar, or bottom slide-in card) rendered by the PushNotif SDK without requiring browser notification permission. Use this tool to display promotional popups or announcements to all active website visitors; do not use it to send OS lock-screen push notifications (use send_push_notification instead). Prerequisite: call list_apps first to obtain app_id. Requires PUSHNOTIF_API_KEY; saving configuration costs 0 credits, and each live visitor impression deducts 1 credit. Returns JSON { ok, app_id, inapp_enabled, inapp_style, inapp_trigger, inapp_freq }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
app_idYesTarget application ID in format app_xxxx (obtain from list_apps)
inapp_bodyYesBanner supporting message text (1 to 240 characters)
inapp_freqNoPer-visitor frequency cap: 'once_per_session' (default), 'once_per_day', 'cooldown_3h', 'cooldown_12h', 'once_per_week', or 'always'
inapp_styleNoVisual layout style: 'modal' (center dialog), 'top_bar' (sticky top ribbon), or 'bottom_slide' (corner toast card)
inapp_titleYesBanner headline text (1 to 100 characters)
inapp_accentNoOptional hex color code for the CTA button and accent border (default: '#0058BE')
inapp_cta_urlNoOptional HTTPS URL opened when the CTA button is clicked
inapp_enabledNoSet true to activate the banner on the website, or false to pause it (default: true)
inapp_triggerNoDisplay trigger condition: 'immediate' (default), 'delay_5s', 'delay_10s', 'scroll_50', 'scroll_80', or custom DOM event 'event:<name>'
inapp_cta_textNoOptional call-to-action button label (e.g., 'Klaim Voucher →')

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.1.2
    • changedInput schema / properties / app_id / description
      Previous value: -"App ID yang ingin diatur"New value: +"Target application ID in format app_xxxx (obtain from list_apps)"
    • changedInput schema / properties / inapp_accent / description
      Previous value: -"Kode warna HEX tombol (misal: #0058BE, #047857, #E11D48)"New value: +"Optional hex color code for the CTA button and accent border (default: '#0058BE')"
    • changedInput schema / properties / inapp_body / description
      Previous value: -"Isi pesan singkat"New value: +"Banner supporting message text (1 to 240 characters)"
    • changedInput schema / properties / inapp_cta_text / description
      Previous value: -"Teks tombol aksi (CTA)"New value: +"Optional call-to-action button label (e.g., 'Klaim Voucher →')"
    • changedInput schema / properties / inapp_cta_url / description
      Previous value: -"URL tujuan saat tombol diklik"New value: +"Optional HTTPS URL opened when the CTA button is clicked"
    • changedInput schema / properties / inapp_enabled / description
      Previous value: -"True untuk mengaktifkan banner di website/aplikasi"New value: +"Set true to activate the banner on the website, or false to pause it (default: true)"
    • changedInput schema / properties / inapp_freq / description
      Previous value: -"Frekuensi tampil: once_per_session, once_per_day, always, cooldown_3h, cooldown_12h, once_per_week"New value: +"Per-visitor frequency cap: 'once_per_session' (default), 'once_per_day', 'cooldown_3h', 'cooldown_12h', 'once_per_week', or 'always'"
    • changedInput schema / properties / inapp_style / description
      Previous value: -"Gaya tampilan: modal, top_bar, atau bottom_slide"New value: +"Visual layout style: 'modal' (center dialog), 'top_bar' (sticky top ribbon), or 'bottom_slide' (corner toast card)"
    • changedInput schema / properties / inapp_title / description
      Previous value: -"Judul pengumuman/promo"New value: +"Banner headline text (1 to 100 characters)"
    • changedInput schema / properties / inapp_trigger / description
      Previous value: -"Pemicu muncul: immediate, delay_5s, delay_10s, scroll_50, scroll_80, atau event:nama_event (misal: event:add_to_cart, event:payment_success)"New value: +"Display trigger condition: 'immediate' (default), 'delay_5s', 'delay_10s', 'scroll_50', 'scroll_80', or custom DOM event 'event:<name>'"
  2. First observedv2.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false), the description discloses the auth requirement (PUSHNOTIF_API_KEY), the credit/cost model (0 credits to save, 1 credit per live visitor impression), and the no-browser-permission rendering constraint. That is exactly the kind of operational context the structured fields cannot convey.

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 single paragraph is front-loaded with purpose and the sibling exclusion, then prerequisites, cost, and return shape. Every clause carries information, though the trailing return-value enumeration makes it slightly dense for a one-paragraph block.

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?

For a ten-parameter mutation tool with no output schema, the description covers the gaps that matter: prerequisite ordering, auth key, cost per impression, sibling routing, and the return JSON keys. An agent has everything needed to call it 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?

Schema description coverage is 100%, so all ten parameters including enums-in-prose (inapp_freq, inapp_style, inapp_trigger) are already documented in the schema. The description restates the style variants in prose but adds no syntax, format, or default information beyond what the schema provides, so the baseline 3 applies.

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 names a specific verb (configure and publish) and resource (on-site In-App Popup or Banner), enumerates the three rendering styles, and explicitly differentiates itself from the sibling send_push_notification. An agent can distinguish this from every other tool in the sibling list without opening a schema.

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 states when to use it (promotional popups or announcements to all active website visitors), when not to use it (OS lock-screen push, with the exact alternative named), and gives a concrete prerequisite workflow (call list_apps first to obtain app_id). Nothing is left to inference.

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